IPageLinkManager

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

lumis.portal.page.link
Interface IPageLinkManager

Package class diagram package IPageLinkManager

All Known Implementing Classes:: PageLinkManager

@StableMinor(version="4.1", 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)` If a matching pagelink is not found for the given type and website, the return should be null.
`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

If a matching pagelink is not found for the given type and website, the return should be null.

Parameters:: sessionConfig -; type -; website -; transaction -
Returns:: a PageLinkConfig.
Throws:: ManagerException; PortalException

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