lumis.portal.page.link
Interface IPageLinkManagerSPI

All Superinterfaces:

IPageLinkManager

All Known Implementing Classes:

PageLinkManager

public interface IPageLinkManagerSPI
extends IPageLinkManager

This interface is a extension of IPageLinkManager for internal uses.

Since:

6.0.0

Method Summary

PageLinkConfig	getByTypeAndWebsite(SessionConfig sessionConfig, int type, java.lang.String website, PortalRequestContext requestContext, ITransaction transaction) This method calls the IPageLinkManager.getByTypeWebsiteAndChannelId(SessionConfig, int, String, String, ITransaction) method with null as the destination channelId.
PageLinkConfig	getByTypeWebsiteAndChannelId(SessionConfig sessionConfig, int type, java.lang.String website, java.lang.String channelId, PortalRequestContext requestContext, ITransaction transaction) The most appropriate page link is identified based on the type, website, destination channelId and context.

Methods inherited from interface lumis.portal.page.link.IPageLinkManager

add, delete, get, getByPageId, getByTypeAndWebsite, getByTypeWebsiteAndChannelId, update

Method Detail

getByTypeAndWebsite

PageLinkConfig getByTypeAndWebsite(SessionConfig sessionConfig,
                                   int type,
                                   java.lang.String website,
                                   PortalRequestContext requestContext,
                                   ITransaction transaction)
                                   throws PortalException

This method calls the IPageLinkManager.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.

requestContext - the list of all request context.

transaction - the current transaction.

Returns:

a PageLinkConfig. The calculated (PageLinkConfig

Throws:

PortalException

Since:

6.0.0

getByTypeWebsiteAndChannelId

PageLinkConfig getByTypeWebsiteAndChannelId(SessionConfig sessionConfig,
                                            int type,
                                            java.lang.String website,
                                            java.lang.String channelId,
                                            PortalRequestContext requestContext,
                                            ITransaction transaction)
                                            throws PortalException

The most appropriate page link is identified based on the type, website, destination channelId and context. 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.
• 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.
• And as last criteria the most appropriated context is consider to define witch page is better or not to be selected.

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.

requestContext - the list of all request context.

transaction - the current transaction.

Returns:

The calculated page link.

Throws:

PortalException

Since:

6.0.0