Package lumis.portal.page.template

Interface IPageTemplateManager

All Known Implementing Classes:

PageTemplateManager

@StableMinor(version="14.1",
             sinceVersion="4.0")
public interface IPageTemplateManager

Since:

4.0.0

Version:

$Revision: 24683 $ $Date: 2021-08-23 18:55:58 -0300 (Mon, 23 Aug 2021) $

Method Summary

Modifier and Type	Method	Description
String	generateDefaultLayout(SessionConfig sessionConfig, String pageId, ITransaction transaction)
boolean	hasInterfaceHolder(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction)	Returns true if the given page template has an interface holder
void	updatePageLayoutFromTemplate(SessionConfig sessionConfig, String pageId, ITransaction transaction)	Updates the given page layout based on the layout of the template that the page belongs to.

Method Detail

updatePageLayoutFromTemplate

void updatePageLayoutFromTemplate(SessionConfig sessionConfig,
                                  String pageId,
                                  ITransaction transaction)
                           throws ManagerException,
                                  PortalException

Updates the given page layout based on the layout of the template that the page belongs to. If the page does not belong to a template, an exception is thrown.

Parameters:

sessionConfig - The user session id must have rights to update the page layout.

pageId - The destination page id. This page layout will be modified.

transaction - A transaction that the update layout should be part of.

Throws:

ManagerException

PortalException

generateDefaultLayout

String generateDefaultLayout(SessionConfig sessionConfig,
                             String pageId,
                             ITransaction transaction)
                      throws ManagerException,
                             PortalException

Parameters:

sessionConfig -

pageId -

transaction -

Returns:

a String.

Throws:

ManagerException

PortalException

hasInterfaceHolder

boolean hasInterfaceHolder(SessionConfig sessionConfig,
                           PageConfig pageConfig,
                           ITransaction transaction)
                    throws ManagerException,
                           PortalException

Returns true if the given page template has an interface holder

Parameters:

sessionConfig -

pageConfig -

transaction -

Returns:

Throws:

ManagerException

PortalException