Package lumis.portal.presentation

Interface IPresentationManager

All Known Subinterfaces:

IPresentationManagerSPI

All Known Implementing Classes:

PresentationManager

@StableMinor(version="17.0",
             sinceVersion="4.0")
public interface IPresentationManager

Since:

4.0.0

Version:

$Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_PRESENTATION_OUTPUT_DATE_TIME	PropertyBag name that indicates whether the generated HTML will contain the generation date and time.
static java.lang.String	PROPERTY_PRESENTATION_OUTPUT_SERVER_ID	PropertyBag name that indicates whether the generated HTML will contain the generator server id.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getAdministrationBarChannelIds(SessionConfig sessionConfig, ITransaction transaction)	Get the Ids of the administration bar of the Channel.
PageConfig	getDefaultPage(SessionConfig sessionConfig, java.lang.String pageId, java.lang.String channelId, java.lang.String website, int mode, ITransaction daoTransaction)	Deprecated. Since 6.2.0 replaced by getDefaultPage(SessionConfig, String, String, IWebsiteBaseURL, int, ITransaction).
PageConfig	getDefaultPage(SessionConfig sessionConfig, java.lang.String pageId, java.lang.String channelId, IWebsiteBaseURL websiteBaseURL, int mode, ITransaction daoTransaction)	Get the default Page.
void	resetAdministrationBarChannelIds()	Reset the administration bar of the Channel.

Field Detail

PROPERTY_PRESENTATION_OUTPUT_SERVER_ID

static final java.lang.String PROPERTY_PRESENTATION_OUTPUT_SERVER_ID

PropertyBag name that indicates whether the generated HTML will contain the generator server id.

See Also:

PortalContext.getServerId(), Constant Field Values

PROPERTY_PRESENTATION_OUTPUT_DATE_TIME

static final java.lang.String PROPERTY_PRESENTATION_OUTPUT_DATE_TIME

PropertyBag name that indicates whether the generated HTML will contain the generation date and time.

See Also:

Constant Field Values

Method Detail

getDefaultPage

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

Deprecated.

Since 6.2.0 replaced by getDefaultPage(SessionConfig, String, String, IWebsiteBaseURL, int, 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.

daoTransaction - the current transaction.

Returns:

a PageConfig.

Throws:

PortalException - if any error occurs during the processing

ManagerException

getDefaultPage

PageConfig getDefaultPage(SessionConfig sessionConfig,
                          java.lang.String pageId,
                          java.lang.String channelId,
                          IWebsiteBaseURL websiteBaseURL,
                          int mode,
                          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.

daoTransaction - the current transaction.

Returns:

a PageConfig.

Throws:

PortalException - if any error occurs during the processing.

Since:

6.2.0

getAdministrationBarChannelIds

java.util.List<java.lang.String> getAdministrationBarChannelIds(SessionConfig sessionConfig,
                                                                ITransaction transaction)
                                                         throws PortalException

Get the Ids of the administration bar of the Channel.

Parameters:

sessionConfig -

transaction -

Returns:

an arrays of Strings.

Throws:

PortalException

resetAdministrationBarChannelIds

void resetAdministrationBarChannelIds()
                               throws PortalException

Reset the administration bar of the Channel.

Throws:

PortalException