lumis.portal.page.link
Interface IPageLinkManager

Package class diagram package IPageLinkManager
All Known Implementing Classes:
PageLinkManager

@StableMinor(version="5.5",
             sinceVersion="4.0")
public interface IPageLinkManager

Since:
4.0.0

Method Summary
 String add(SessionConfig sessionConfig, PageLinkConfig pageLinkConfig, ITransaction transaction)
          Add a page link.
 void delete(SessionConfig sessionConfig, String pageLinkId, ITransaction transaction)
          Delete a page link.
 PageLinkConfig get(SessionConfig sessionConfig, String pageLinkId, ITransaction transaction)
          Get the page link configuraton.
 Collection<String> getByPageId(SessionConfig sessionConfig, String pageId, ITransaction transaction)
          Get the page link ids associated to a page
 PageLinkConfig getByTypeAndWebsite(SessionConfig sessionConfig, int type, String website, ITransaction transaction)
          This method calls the getByTypeWebsiteAndChannelId(SessionConfig, int, String, String, ITransaction) method with null as the destination channelId.
 PageLinkConfig getByTypeWebsiteAndChannelId(SessionConfig sessionConfig, int type, String website, String channelId, ITransaction transaction)
          The most appropriate page link is identified based on the type, website and destination channelId.
 void update(SessionConfig sessionConfig, PageLinkConfig pageLinkConfig, ITransaction transaction)
          Update the page link.
 

Method Detail

add

String add(SessionConfig sessionConfig,
           PageLinkConfig pageLinkConfig,
           ITransaction transaction)
           throws ManagerException,
                  PortalException
Add a page link.

Parameters:
sessionConfig -
pageLinkConfig -
transaction -
Returns:
a String.
Throws:
ManagerException
PortalException

get

PageLinkConfig get(SessionConfig sessionConfig,
                   String pageLinkId,
                   ITransaction transaction)
                   throws ManagerException,
                          PortalException
Get the page link configuraton.

Parameters:
sessionConfig -
pageLinkId -
transaction -
Returns:
a PageLinkConfig.
Throws:
ManagerException
PortalException

getByPageId

Collection<String> getByPageId(SessionConfig sessionConfig,
                               String pageId,
                               ITransaction transaction)
                               throws ManagerException,
                                      PortalException
Get the page link ids associated to a page

Parameters:
sessionConfig -
pageId -
transaction -
Returns:
Throws:
ManagerException
PortalException

getByTypeAndWebsite

PageLinkConfig getByTypeAndWebsite(SessionConfig sessionConfig,
                                   int type,
                                   String website,
                                   ITransaction transaction)
                                   throws ManagerException,
                                          PortalException
This method calls the getByTypeWebsiteAndChannelId(SessionConfig, int, String, String, ITransaction) method with null as the destination channelId.

Parameters:
sessionConfig - the session identifier of the current user.
type - the page link type.
website - the website that the user is accessing.
transaction - the current transaction.
Returns:
a PageLinkConfig. The calculated (PageLinkConfig
Throws:
ManagerException
PortalException

getByTypeWebsiteAndChannelId

PageLinkConfig getByTypeWebsiteAndChannelId(SessionConfig sessionConfig,
                                            int type,
                                            String website,
                                            String channelId,
                                            ITransaction transaction)
                                            throws ManagerException,
                                                   PortalException
The most appropriate page link is identified based on the type, website and destination channelId. In order to calculate the page link the following criteria are used: If no matching pagelink is found return null.

Parameters:
sessionConfig - the session identifier of the current user.
type - the page link type.
website - the website that the user is accessing.
channelId - The destination channel identifier.
transaction - the current transaction.
Returns:
The calculated page link.
Throws:
ManagerException
PortalException
Since:
5.0.0

update

void update(SessionConfig sessionConfig,
            PageLinkConfig pageLinkConfig,
            ITransaction transaction)
            throws ManagerException,
                   PortalException
Update the page link.

Parameters:
sessionConfig -
pageLinkConfig -
transaction -
Throws:
ManagerException
PortalException

delete

void delete(SessionConfig sessionConfig,
            String pageLinkId,
            ITransaction transaction)
            throws ManagerException,
                   PortalException
Delete a page link.

Parameters:
sessionConfig -
pageLinkId -
transaction -
Throws:
ManagerException
PortalException


Lumisportal  5.5.0.091130 - Copyright © 2001-2007, Lumis. All Rights Reserved.