@StableMinor(version="12.5", sinceVersion="4.0") public interface IPageManager extends IConfigDeleter, IConfigKeyChecker
Modifier and Type | Method and Description |
---|---|
String |
add(SessionConfig sessionConfig,
PageConfig pageConfig,
ITransaction transaction)
Add a page.
|
void |
addCssLink(SessionConfig sessionConfig,
String pageId,
String cssId,
int position,
ITransaction transaction)
Add the hyperlink to the page's CSS file.
|
void |
addOrUpdate(SessionConfig sessionConfig,
PageConfig pageConfig,
ITransaction transaction)
Add or Update a Page, depending on its previous existence.
|
void |
clearCache(SessionConfig sessionConfig,
Collection<String> pageIds,
ITransaction transaction)
Clears the cache for a group of pages.
|
void |
clearCache(SessionConfig sessionConfig,
String pageId,
ITransaction transaction)
Clear the page cache.
|
void |
copy(SessionConfig sessionConfig,
String sourcePageId,
String destinationPageId,
ITransaction transaction)
Copy the layout and properties from the original page to the destination
page.
|
void |
delete(SessionConfig sessionConfig,
String pageId,
ITransaction transaction)
Delete a page.
|
void |
deleteCssLink(SessionConfig sessionConfig,
String pageId,
String cssId,
ITransaction transaction)
Delete the hyperlink to the page's CSS file.
|
void |
deleteOrphanInterfaces(SessionConfig sessionConfig,
String pageId,
ITransaction daoTransaction)
Remove any interface instance associated to the page that is not being referenced in it's layout.
|
String |
deserialize(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node pageNode,
boolean firstDeserialization,
ITransaction transaction) |
String |
deserialize(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node pageNode,
ITransaction transaction) |
void |
deserializeCss(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node cssLinksNodes,
ITransaction transaction) |
void |
disconnectFromTemplate(SessionConfig sessionConfig,
String pageId,
ITransaction transaction)
Disconnect the page from its template if one exists
|
PageConfig |
get(SessionConfig sessionConfig,
String pageId,
ITransaction transaction)
Get the configuration of the page.
|
int |
getCachePage(SessionConfig sessionConfig,
PageConfig pageConfig,
ITransaction transaction) |
boolean |
getCenterPage(SessionConfig sessionConfig,
PageConfig pageConfig,
ITransaction transaction) |
List<String> |
getCssIds(SessionConfig sessionConfig,
String pageId,
ITransaction transaction)
Get a list of Css Ids of the page.
|
List<String> |
getCssIdsRecursively(SessionConfig sessionConfig,
String pageId,
ITransaction transaction)
Get a list of Css Ids of the page including inherited Css.
|
String |
getFirstIdByChannelId(SessionConfig sessionConfig,
String channelId,
ITransaction transaction) |
PageConfig |
getFirstPageByChannelIdRecursively(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Returns the first page for a channel, including pages in sub-channels.
|
List<String> |
getIdsByParentChannelId(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Returns all the pages that have the given channel as their parent
channel.
|
List<String> |
getIdsByParentChannelIdRecursively(SessionConfig sessionConfig,
String channelId,
ITransaction transaction) |
Collection<String> |
getIdsByParentTemplateId(SessionConfig sessionConfig,
String parentTemplateId,
ITransaction transaction) |
Collection<String> |
getIdsByServiceInstanceId(SessionConfig sessionConfig,
String serviceInstanceId,
ITransaction transaction) |
int |
getLayoutType(SessionConfig sessionConfig,
PageConfig pageConfig,
ITransaction transaction)
Returns the layout type used for rendering the page to the end user.
|
List<String> |
getMetaTagIdsRecursively(SessionConfig sessionConfig,
PageConfig pageConfig,
ITransaction transaction)
Get a list of Meta-Tags Ids of the page including inherited Meta-Tags.
|
String |
getPageWebResourceDataProviderClassName(SessionConfig sessionConfig,
PageConfig pageConfig,
ITransaction transaction)
Returns the
IPageWebResourceDataProvider
class name for the given page. |
List<String> |
getParentPathIds(SessionConfig sessionConfig,
String pageId,
ITransaction transaction)
Returns the Ids of parent channels recursively.
|
String |
getPath(SessionConfig sessionConfig,
String pageId,
boolean localizable,
ITransaction transaction)
Returns the complete path beginning from the root channel to the page.
|
String |
getPath(SessionConfig sessionConfig,
String pageId,
ITransaction transaction)
Returns the complete path beginning from the root channel to the page.
|
String |
getProtocolScheme(SessionConfig sessionConfig,
int protocolType,
ITransaction transaction)
Return the protocol Scheme of the page given a protocol type.
|
int |
getProtocolType(SessionConfig sessionConfig,
PageConfig pageConfig,
ITransaction transaction)
Returns the protocolType of the given page.
|
String |
getRuntimeDataProviderClassName(SessionConfig sessionConfig,
PageConfig pageConfig,
ITransaction transaction)
Deprecated.
Since 5.0.0 replaced by
getPageWebResourceDataProviderClassName(SessionConfig, PageConfig, ITransaction) . |
void |
serialize(SessionConfig sessionConfig,
String pageId,
OutputStream outputStream,
ITransaction transaction) |
void |
serializeCss(SessionConfig sessionConfig,
String pageId,
OutputStream outputStream,
ITransaction transaction) |
void |
update(SessionConfig sessionConfig,
PageConfig pageConfig,
ITransaction transaction)
Update a page.
|
void |
updateDeserializedPageLayout(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
String pageId,
ITransaction transaction) |
void |
updateLayout(SessionConfig sessionConfig,
String pageId,
String layout,
ITransaction transaction)
Update the page layout.
|
void |
updateSsiProperty(SessionConfig sessionConfig,
ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
ITransaction transaction)
Updates the server side include property of the interface's page.
|
deleteConfig
keyExists
void addOrUpdate(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageConfig
- transaction
- ManagerException
PortalException
String add(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageConfig
- transaction
- ManagerException
PortalException
void copy(SessionConfig sessionConfig, String sourcePageId, String destinationPageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- sourcePageId
- destinationPageId
- transaction
- ManagerException
PortalException
PageConfig get(SessionConfig sessionConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- transaction
- ManagerException
PortalException
void delete(SessionConfig sessionConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- transaction
- ManagerException
PortalException
void update(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageConfig
- transaction
- ManagerException
PortalException
void updateLayout(SessionConfig sessionConfig, String pageId, String layout, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageConfig
- transaction
- ManagerException
PortalException
void updateSsiProperty(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction) throws PortalException
If the server side include is to be calculated automatically, this method checks if any of the interface instances within the page have the ssi property set to true. If so the ssi property of the page is set to true.
sessionConfig
- serviceInterfaceInstanceConfig
- transaction
- PortalException
String getPath(SessionConfig sessionConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- transaction
- ManagerException
PortalException
String getPath(SessionConfig sessionConfig, String pageId, boolean localizable, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- transaction
- localizable
- ManagerException
PortalException
List<String> getParentPathIds(SessionConfig sessionConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- transaction
- ManagerException
PortalException
List<String> getIdsByParentChannelId(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The user session id must have rights to read the page listchannelId
- Id of the channeltransaction
- A transaction that should be used for acessing information
from the databaseManagerException
PortalException
String getFirstIdByChannelId(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- channelId
- transaction
- ManagerException
PortalException
List<String> getIdsByParentChannelIdRecursively(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- channelId
- transaction
- ManagerException
PortalException
void addCssLink(SessionConfig sessionConfig, String pageId, String cssId, int position, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- cssId
- position
- transaction
- ManagerException
PortalException
void deleteCssLink(SessionConfig sessionConfig, String pageId, String cssId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- cssId
- transaction
- ManagerException
PortalException
List<String> getCssIds(SessionConfig sessionConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- transaction
- ManagerException
PortalException
List<String> getCssIdsRecursively(SessionConfig sessionConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- transaction
- ManagerException
PortalException
List<String> getMetaTagIdsRecursively(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageConfig
- transaction
- ManagerException
PortalException
void disconnectFromTemplate(SessionConfig sessionConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- transaction
- ManagerException
PortalException
boolean getCenterPage(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageConfig
- transaction
- ManagerException
PortalException
int getLayoutType(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction) throws ManagerException, PortalException
The return would be one of PageConfig.PAGE_LAYOUT_TYPE_INHERIT
,
PageConfig.PAGE_LAYOUT_TYPE_WITH_TABLES
or PageConfig.PAGE_LAYOUT_TYPE_TABLELESS
sessionConfig
- pageConfig
- transaction
- ManagerException
PortalException
int getCachePage(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageConfig
- transaction
- ManagerException
PortalException
void serialize(SessionConfig sessionConfig, String pageId, OutputStream outputStream, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- outputStream
- transaction
- ManagerException
PortalException
String deserialize(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node pageNode, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- deserializationConfig
- pageNode
- transaction
- ManagerException
PortalException
String deserialize(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node pageNode, boolean firstDeserialization, ITransaction transaction) throws ManagerException, PortalException
ManagerException
PortalException
void updateDeserializedPageLayout(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- deserializationConfig
- pageId
- transaction
- ManagerException
PortalException
Collection<String> getIdsByServiceInstanceId(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction) throws PortalException
sessionConfig
- identifier for the session.serviceInstanceId
- the id of the service instance.transaction
- the transaction for persistence access.PortalException
void serializeCss(SessionConfig sessionConfig, String pageId, OutputStream outputStream, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageId
- outputStream
- transaction
- ManagerException
PortalException
void deserializeCss(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node cssLinksNodes, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- deserializationConfig
- cssLinksNodes
- transaction
- ManagerException
PortalException
Collection<String> getIdsByParentTemplateId(SessionConfig sessionConfig, String parentTemplateId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- parentTemplateId
- transaction
- ManagerException
PortalException
void clearCache(SessionConfig sessionConfig, String pageId, ITransaction transaction) throws ManagerException, PortalException
This method clears the following caches
sessionConfig
- pageId
- transaction
- ManagerException
PortalException
clearCache(SessionConfig, Collection, ITransaction)
void clearCache(SessionConfig sessionConfig, Collection<String> pageIds, ITransaction transaction) throws PortalException
PageConfig
instances cacheIServiceInterfaceInstanceManager.clearCache(SessionConfig, String, ITransaction)
for each interface instance in the pages.clearCache(SessionConfig, String, ITransaction)
.sessionConfig
- the user session information.pageIds
- the page identifiers.transaction
- the transaction for persistence access.PortalException
clearCache(SessionConfig, String, ITransaction)
void deleteOrphanInterfaces(SessionConfig sessionConfig, String pageId, ITransaction daoTransaction) throws ManagerException, PortalException
sessionConfig
- pageId
- daoTransaction
- ManagerException
PortalException
int getProtocolType(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction) throws ManagerException, PortalException
This method checks recursively up the page´s ancestors until it finds a
protocolType that is not PageConfig.PAGE_PROTOCOL_INHERIT
.
Possible protocol types are:
PageConfig.PAGE_PROTOCOL_HTTP
PageConfig.PAGE_PROTOCOL_HTTPS
PageConfig.PAGE_PROTOCOL_ALL
sessionConfig
- pageConfig
- transaction
- ManagerException
PortalException
String getProtocolScheme(SessionConfig sessionConfig, int protocolType, ITransaction transaction) throws ManagerException, PortalException
This method returns a string representation of the protocol type.
sessionConfig
- protocolType
- transaction
- PageConfig.PAGE_PROTOCOL_HTTP
, PageConfig.PAGE_PROTOCOL_HTTP_NAME
is returned.
PageConfig.PAGE_PROTOCOL_HTTPS
, PageConfig.PAGE_PROTOCOL_HTTPS_NAME
is returned.
ManagerException
PortalException
@Deprecated String getRuntimeDataProviderClassName(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction) throws PortalException
getPageWebResourceDataProviderClassName(SessionConfig, PageConfig, ITransaction)
.sessionConfig
- current user sessionpageConfig
- page configurationtransaction
- current transactionPortalException
String getPageWebResourceDataProviderClassName(SessionConfig sessionConfig, PageConfig pageConfig, ITransaction transaction) throws PortalException
IPageWebResourceDataProvider
class name for the given page.
This method recursively traverses up a channel tree starting from the given page until the first channel that does not inherit the web resource data provider property. Based on the page web resource data provider type, either a standard or customized page web resource data provider class name is returned.
sessionConfig
- user session information.pageConfig
- the page.transaction
- the transaction for persistence access.PortalException
PageConfig getFirstPageByChannelIdRecursively(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.channelId
- the channel identifier.transaction
- the transaction for persistence access.PortalObjectNotFoundException
- if no such page was found.PortalException
LumisXP 12.5.0.200928 - Copyright © 2006–2020 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.