lumis.portal.page.link
Class PageLinkManager

java.lang.Object
  lumis.portal.page.link.PageLinkManager

All Implemented Interfaces:

IPageLinkManager

public class PageLinkManager
extends Object
implements IPageLinkManager

Page Link Manager.

Since:

5.0.0

Constructor Summary

PageLinkManager()

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 IPageLinkManager.getByTypeWebsiteAndChannelId(SessionConfig, int, String, String, ITransaction) method with null as the destination channelId.
PageLinkConfig	getByTypeWebsiteAndChannelId(SessionConfig sessionConfig, int type, String website, String requestedChannelId, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageLinkManager

public PageLinkManager()

Method Detail

add

public String add(SessionConfig sessionConfig,
                  PageLinkConfig pageLinkConfig,
                  ITransaction transaction)
           throws ManagerException,
                  PortalException

Description copied from interface: IPageLinkManager

Add a page link.

Specified by:

add in interface IPageLinkManager

Returns:

a String.

Throws:

ManagerException

PortalException

get

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

Description copied from interface: IPageLinkManager

Get the page link configuraton.

Specified by:

get in interface IPageLinkManager

Returns:

a PageLinkConfig.

Throws:

ManagerException

PortalException

getByPageId

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

Description copied from interface: IPageLinkManager

Get the page link ids associated to a page

Specified by:

getByPageId in interface IPageLinkManager

Returns:

Throws:

ManagerException

PortalException

getByTypeAndWebsite

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

Description copied from interface: IPageLinkManager

This method calls the IPageLinkManager.getByTypeWebsiteAndChannelId(SessionConfig, int, String, String, ITransaction) method with null as the destination channelId.

Specified by:

getByTypeAndWebsite in interface IPageLinkManager

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

public PageLinkConfig getByTypeWebsiteAndChannelId(SessionConfig sessionConfig,
                                                   int type,
                                                   String website,
                                                   String requestedChannelId,
                                                   ITransaction transaction)
                                            throws ManagerException,
                                                   PortalException

Description copied from interface: IPageLinkManager

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:

• 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.

If no matching pagelink is found return null.

Specified by:

getByTypeWebsiteAndChannelId in interface IPageLinkManager

Parameters:

sessionConfig - the session identifier of the current user.

type - the page link type.

website - the website that the user is accessing.

requestedChannelId - The destination channel identifier.

transaction - the current transaction.

Returns:

The calculated page link.

Throws:

ManagerException

PortalException

update

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

Description copied from interface: IPageLinkManager

Update the page link.

Specified by:

update in interface IPageLinkManager

Throws:

ManagerException

PortalException

delete

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

Description copied from interface: IPageLinkManager

Delete a page link.

Specified by:

delete in interface IPageLinkManager

Throws:

ManagerException

PortalException