Package lumis.portal.presentation

Interface IPresentationManagerSPI

All Superinterfaces:

IPresentationManager

All Known Implementing Classes:

PresentationManager

public interface IPresentationManagerSPI
extends IPresentationManager

This interface is a extension of IPresentationManager for internal uses.

Since:

6.0.0

Version:

$Revision$ $Date$

Field Summary

Fields inherited from interface lumis.portal.presentation.IPresentationManager

PROPERTY_PRESENTATION_OUTPUT_DATE_TIME, PROPERTY_PRESENTATION_OUTPUT_SERVER_ID

Method Summary

Modifier and Type	Method	Description
void	clearChannelHtmlProcessorsCache(java.lang.String channelId)	Clears the IHtmlProcessor cache.
void	clearHtmlProcessorsCache()	Clears all HTML processor cache.
void	clearServiceInstanceHtmlProcessorsCache(java.lang.String serviceInstanceId)	Clears the IHtmlProcessor cache.
PageConfig	getDefaultPage(SessionConfig sessionConfig, java.lang.String pageId, java.lang.String channelId, java.lang.String website, int mode, PortalRequestContext requestContext, ITransaction daoTransaction)	Deprecated. Since 6.2.0 replaced by getDefaultPage(SessionConfig, String, String, IWebsiteBaseURL, IPortalMode, PortalRequestContext, ITransaction).
PageConfig	getDefaultPage(SessionConfig sessionConfig, java.lang.String pageId, java.lang.String channelId, IWebsiteBaseURL websiteBaseURL, IPortalMode mode, PortalRequestContext requestContext, boolean fallbackToFirstWebsitePage, ITransaction transaction)	Get the default Page.
PageConfig	getDefaultPage(SessionConfig sessionConfig, java.lang.String pageId, java.lang.String channelId, IWebsiteBaseURL websiteBaseURL, IPortalMode mode, PortalRequestContext requestContext, ITransaction daoTransaction)	Get the default Page.
java.util.List<IHtmlProcessor>	getProcessors(PageWebResource webResource)	Returns a list with the HTML processors for the given web resource.

Methods inherited from interface lumis.portal.presentation.IPresentationManager

getAdministrationBarChannelIds, getDefaultPage, getDefaultPage, resetAdministrationBarChannelIds

Method Detail

getDefaultPage

@Deprecated
PageConfig getDefaultPage(SessionConfig sessionConfig,
                          java.lang.String pageId,
                          java.lang.String channelId,
                          java.lang.String website,
                          int mode,
                          PortalRequestContext requestContext,
                          ITransaction daoTransaction)
                   throws PortalException

Deprecated.

Since 6.2.0 replaced by getDefaultPage(SessionConfig, String, String, IWebsiteBaseURL, IPortalMode, PortalRequestContext, ITransaction).

Get the default Page.

Parameters:

sessionConfig - the session identifier of the current user.

pageId - The destination page identifier.

channelId - The destination channel identifier.

website - the website base URL that the user is accessing.

mode - the current portal mode.

requestContext - the portal request context map.

daoTransaction - the current transaction.

Returns:

a PageConfig.

Throws:

PortalException

Since:

6.0.0

getDefaultPage

PageConfig getDefaultPage(SessionConfig sessionConfig,
                          java.lang.String pageId,
                          java.lang.String channelId,
                          IWebsiteBaseURL websiteBaseURL,
                          IPortalMode mode,
                          PortalRequestContext requestContext,
                          ITransaction daoTransaction)
                   throws PortalException

Get the default Page.

Parameters:

sessionConfig - the session identifier of the current user.

pageId - The destination page identifier.

channelId - The destination channel identifier.

websiteBaseURL - the IWebsiteBaseURL that the user is accessing.

mode - the current portal mode.

requestContext - the portal request context map.

daoTransaction - the current transaction.

Returns:

a PageConfig.

Throws:

PortalException

Since:

6.2.0

getDefaultPage

PageConfig getDefaultPage(SessionConfig sessionConfig,
                          java.lang.String pageId,
                          java.lang.String channelId,
                          IWebsiteBaseURL websiteBaseURL,
                          IPortalMode mode,
                          PortalRequestContext requestContext,
                          boolean fallbackToFirstWebsitePage,
                          ITransaction transaction)
                   throws PortalException

Get the default Page.

Parameters:

sessionConfig - the session identifier of the current user.

pageId - The destination page identifier.

channelId - The destination channel identifier.

websiteBaseURL - the IWebsiteBaseURL that the user is accessing.

mode - the current portal mode.

requestContext - the portal request context map.

fallbackToFirstWebsitePage - if true, will try to fallback to first website's page if pageId and channelId not specified and no applicable PageLinkConfig exists; otherwise will return null.

transaction - the current transaction.

Returns:

the default page, or null if it was not found.

Throws:

PortalException

Since:

8.0.0

getProcessors

java.util.List<IHtmlProcessor> getProcessors(PageWebResource webResource)
                                      throws PortalException

Returns a list with the HTML processors for the given web resource. Based on the given resource, collect all service instances that belongs to services that has HMTL processors and order them by priority.

Parameters:

webResource - the web resource.

Returns:

a list with the HTML processors for the given web resource .

Throws:

PortalException

Since:

8.2.0

clearChannelHtmlProcessorsCache

void clearChannelHtmlProcessorsCache(java.lang.String channelId)

Clears the IHtmlProcessor cache.

Parameters:

channelId - the affected channel identifier.

Since:

8.2.0

clearServiceInstanceHtmlProcessorsCache

void clearServiceInstanceHtmlProcessorsCache(java.lang.String serviceInstanceId)

Clears the IHtmlProcessor cache.

Parameters:

serviceInstanceId - the affected service instance identifier.

Since:

8.2.0

clearHtmlProcessorsCache

void clearHtmlProcessorsCache()

Clears all HTML processor cache.

Since:

8.2.0