lumis.portal.page.link

Interface IPageLinkManager

All Known Subinterfaces:

IPageLinkManagerSPI

All Known Implementing Classes:

PageLinkManager

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

This interface provides the actions that the Page Link Manager offers to manipulate PageLinks in the Lumis Portal.

Since:

4.0.0

Version:

$Revision: 20413 $ $Date: 2017-07-20 19:57:40 +0000 (Thu, 20 Jul 2017) $

Method Summary

Modifier and Type	Method and Description
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) Deprecated. Since 6.2.0 this method was specialized and replaced by getDefaultLoginPage(SessionConfig, IWebsiteBaseURL, String, ITransaction) and getDefaultHomePage(SessionConfig, IWebsiteBaseURL, ITransaction).
PageLinkConfig	getByTypeWebsiteAndChannelId(SessionConfig sessionConfig, int type, String website, String channelId, ITransaction transaction) Deprecated. Since 6.2.0 this method was specialized and replaced by getDefaultLoginPage(SessionConfig, IWebsiteBaseURL, String, ITransaction) and getDefaultHomePage(SessionConfig, IWebsiteBaseURL, ITransaction).
PageLinkConfig	getDefaultHomePage(SessionConfig sessionConfig, IWebsiteBaseURL websiteBaseURL, ITransaction transaction) Returns the most appropriate home page, based on the given website base URL.
PageLinkConfig	getDefaultLoginPage(SessionConfig sessionConfig, IWebsiteBaseURL websiteBaseURL, String channelId, ITransaction transaction) Returns the most appropriate login page, based on the given website base URL and destination channel identifier.
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 - the session identifier of the current user.

pageLinkConfig - the page link configuration.

transaction - the current transaction.

Returns:

the ID of the Page Link.

Throws:

ManagerException - if any error occurs during the persisting process.

PortalException - if any other error occurs during the process.

get

PageLinkConfig get(SessionConfig sessionConfig,
                   String pageLinkId,
                   ITransaction transaction)
            throws ManagerException,
                   PortalException

Get the page link configuraton.

Parameters:

sessionConfig - the session identifier of the current user.

pageLinkId - id of the page link target.

transaction - the current transaction.

Returns:

a PageLinkConfig.

Throws:

ManagerException - if any error occurs during the persisting process.

PortalException - if any other error occurs during the process.

getByPageId

Collection<String> getByPageId(SessionConfig sessionConfig,
                               String pageId,
                               ITransaction transaction)
                        throws ManagerException,
                               PortalException

Get the page link ids associated to a page

Parameters:

sessionConfig - the session identifier of the current user.

pageId - id of the page target.

transaction - the current transaction.

Returns:

a list of page link ids associated to a page.

Throws:

ManagerException - if any error occurs during the persisting process.

PortalException - if any other error occurs during the process.

getByTypeAndWebsite

@Deprecated
PageLinkConfig getByTypeAndWebsite(SessionConfig sessionConfig,
                                               int type,
                                               String website,
                                               ITransaction transaction)
                                        throws ManagerException,
                                               PortalException

Deprecated. Since 6.2.0 this method was specialized and replaced by getDefaultLoginPage(SessionConfig, IWebsiteBaseURL, String, ITransaction) and getDefaultHomePage(SessionConfig, IWebsiteBaseURL, ITransaction).

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 base URL that the user is accessing.

transaction - the current transaction.

Returns:

a PageLinkConfig. The calculated (PageLinkConfig

Throws:

ManagerException - if any error occurs during the persisting process.

PortalException - if any other error occurs during the process.

getByTypeWebsiteAndChannelId

@Deprecated
PageLinkConfig getByTypeWebsiteAndChannelId(SessionConfig sessionConfig,
                                                        int type,
                                                        String website,
                                                        String channelId,
                                                        ITransaction transaction)
                                                 throws ManagerException,
                                                        PortalException

Deprecated. Since 6.2.0 this method was specialized and replaced by getDefaultLoginPage(SessionConfig, IWebsiteBaseURL, String, ITransaction) and getDefaultHomePage(SessionConfig, IWebsiteBaseURL, ITransaction).

The most appropriate page link is identified based on the website (or URL Rules of the website), type, priority and destination channelId. In order to calculate the page link the following criteria are used:

• First consider a list of all page links that match the given website (or URL Rules of the website), type and priority.
• For pages type Login:
  • Within the list if there are links with channelId specified, prioritize them.
  • If a link's channel is not within the list of parent channels of the destination channel, do not consider it. Else prioritize the closest to the destination channel.
  • Among the links with no channel specified, prioritize the one whose page has a common ancestor with the destination channel closest to the destination channel. Finally consider the distance between this common ancestor and the page link's page.
• For pages type Home Page:
  • Within the list, prioritize the page with the biggest priority.

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 base URL that the user is accessing.

channelId - The destination channel identifier.

transaction - the current transaction.

Returns:

The calculated page link.

Throws:

ManagerException - if any error occurs during the persisting process.

PortalException - if any other error occurs during the process.

Since:

5.0.0

update

void update(SessionConfig sessionConfig,
            PageLinkConfig pageLinkConfig,
            ITransaction transaction)
     throws ManagerException,
            PortalException

Update the page link.

Parameters:

sessionConfig - the session identifier of the current user.

pageLinkConfig - the page link configuration.

transaction - the current transaction.

Throws:

ManagerException - if any error occurs during the persisting process.

PortalException - if any other error occurs during the process.

delete

void delete(SessionConfig sessionConfig,
            String pageLinkId,
            ITransaction transaction)
     throws ManagerException,
            PortalException

Delete a page link.

Parameters:

sessionConfig - the session identifier of the current user.

pageLinkId - id of the page link target.

transaction - the current transaction.

Throws:

ManagerException - if any error occurs during the persisting process.

PortalException - if any other error occurs during the process.

getDefaultLoginPage

PageLinkConfig getDefaultLoginPage(SessionConfig sessionConfig,
                                   IWebsiteBaseURL websiteBaseURL,
                                   String channelId,
                                   ITransaction transaction)
                            throws PortalException

Returns the most appropriate login page, based on the given website base URL and destination channel identifier.

In order to choose the page link the following criteria are used:

• The page link must be associated with the corresponding website.
• If the page link's channel is specified, it must reside in or be equal to the channel corresponding to the channelId argument.
• The page link rules must be fulfilled.
• If multiple page links could be matched, the most priority one is used.

If no matching page link is found, return null.

Parameters:

sessionConfig - the session identifier of the current user.

websiteBaseURL - the IWebsiteBaseURL that the user is accessing.

channelId - The destination channel identifier.

transaction - the current transaction.

Returns:

The calculated page link.

Throws:

PortalException - if any error occurs during the persisting process.

Since:

6.2.0

getDefaultHomePage

PageLinkConfig getDefaultHomePage(SessionConfig sessionConfig,
                                  IWebsiteBaseURL websiteBaseURL,
                                  ITransaction transaction)
                           throws PortalException

Returns the most appropriate home page, based on the given website base URL.

In order to choose the page link the following criteria are used:

• The page link must be associated with the corresponding website.
• The page link rules must be fulfilled.
• If multiple page links could be matched, the most priority one is used.

If no matching page link is found, return null.

Parameters:

sessionConfig - the session identifier of the current user.

websiteBaseURL - the IWebsiteBaseURL that the user is accessing.

transaction - the current transaction.

Returns:

The calculated page link, or null if none matches the search criteria.

Throws:

PortalException - if any error occurs during the persisting process.

Since:

6.2.0