|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@StableMinor(version="6.2", sinceVersion="4.0") public interface IChannelManager
Manager responsible for channel-related operations
Method Summary | |
---|---|
String |
add(SessionConfig sessionConfig,
ChannelConfig channelConfig,
ITransaction transaction)
Add a Channel. |
void |
addCssLink(SessionConfig sessionConfig,
String channelId,
String cssId,
int position,
ITransaction transaction)
Add the hyperlink to the channel's CSS file. |
void |
addOrUpdate(SessionConfig sessionConfig,
ChannelConfig channelConfig,
ITransaction transaction)
Add or Update a Channel, depending on its previous existence. |
void |
clearCache(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Clear the Channel cache. |
String |
copy(SessionConfig sessionConfig,
String sourceChannelId,
String destinationParentChannelId,
ITransaction transaction)
Creates a new channel by copying source channel's properties and structure into destination's parent channel. |
void |
delete(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Delete the Channel. |
void |
deleteCssLink(SessionConfig sessionConfig,
String channelId,
String cssId,
ITransaction transaction)
Delete the hyperlink to the channel's CSS file. |
String |
deserialize(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node channelNode,
ITransaction transaction)
|
void |
deserializeCss(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node cssLinksNodes,
ITransaction transaction)
|
void |
deserializeSecondPass(SessionConfig sessionConfig,
DeserializationConfig deserializationConfig,
Node channelNode,
ITransaction transaction)
Perfoms the second pass of the channels deserialization |
ChannelConfig |
get(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Get the Channel's configuration. |
int |
getCachePages(SessionConfig sessionConfig,
ChannelConfig channelConfig,
ITransaction transaction)
|
boolean |
getCenterPages(SessionConfig sessionConfig,
ChannelConfig channelConfig,
ITransaction transaction)
Get a boolean indicating wheter the page must be centralized. |
int |
getChannelTreeCount(String rootChannelId,
ITransaction transaction)
Returns the number of channels in the tree for which the root is the given channelId. |
List<String> |
getChannelTreeIds(String rootChannelId,
ITransaction transaction)
Returns all the ids of channels in the tree for which the root is the given channelId. |
List<String> |
getCssIds(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Get a list of CSS Ids of the Channel. |
List<String> |
getCssIdsRecursively(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Get a list of Css Ids of the Channel including inherited Css. |
String |
getFriendlyPath(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Get the friendly path of a channel. |
Collection<String> |
getIdsByPageTemplateId(SessionConfig sessionConfig,
String pageTemplateId,
ITransaction transaction)
Retrieves the Ids of all channel that uses the specified page template as default page template |
List<String> |
getIdsByParentChannelId(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Get a list of sub channel's id given the parent Channel's id. |
List<String> |
getIdsByParentTemplateId(SessionConfig sessionConfig,
String parentTemplateId,
ITransaction transaction)
Retrieves the Ids of all channel that uses the specified channel template. |
int |
getLayoutPagesType(SessionConfig sessionConfig,
ChannelConfig channelConfig,
ITransaction transaction)
Get a the page layout format. |
List<String> |
getMetaTagIdsRecursively(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Get a list of meta-tags ids of the Channel including inherit Meta-tag. |
String |
getPageTemplateIdRecursively(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Returns the PageTemplateId for the specified channel (local or inherited from a parent channel) |
String |
getPageWebResourceDataProviderClassName(SessionConfig sessionConfig,
ChannelConfig channelConfig,
ITransaction transaction)
Returns the default IPageWebResourceDataProvider
class name for the child pages of a channel. |
String |
getPath(SessionConfig sessionConfig,
String channelId,
boolean localizable,
ITransaction transaction)
Get the full path of the Channel. |
String |
getPath(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Get the full path of the Channel. |
List<String> |
getPathIds(SessionConfig sessionConfig,
String channelId,
ITransaction transaction)
Get Ids of channel and its parents. |
List<String> |
getPathNames(SessionConfig sessionConfig,
String channelId,
boolean localizable,
ITransaction transaction)
Returns a list of strings each representing the name of the channel between the root portal channel and the channel solicited. |
int |
getProtocolType(SessionConfig sessionConfig,
ChannelConfig channelConfig,
ITransaction transaction)
Returns the protocolType of the given channel. |
String |
getRuntimeDataProviderClassName(SessionConfig sessionConfig,
ChannelConfig channelConfig,
ITransaction transaction)
Deprecated. Since 5.0.0 replaced by getPageWebResourceDataProviderClassName(SessionConfig, ChannelConfig, ITransaction) . |
void |
serialize(SessionConfig sessionConfig,
String channelId,
OutputStream outputStream,
ITransaction transaction)
|
void |
serializeCss(SessionConfig sessionConfig,
String channelId,
OutputStream outputStream,
ITransaction transaction)
|
void |
update(SessionConfig sessionConfig,
ChannelConfig channelConfig,
ITransaction transaction)
Update the Channel. |
Methods inherited from interface lumis.portal.serialization.operation.IConfigKeyChecker |
---|
keyExists |
Method Detail |
---|
void addOrUpdate(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- channelConfig
- transaction
-
ManagerException
PortalException
String add(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- channelConfig
- transaction
-
ManagerException
PortalException
String copy(SessionConfig sessionConfig, String sourceChannelId, String destinationParentChannelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- sourceChannelId
- destinationParentChannelId
- transaction
-
ManagerException
PortalException
ChannelConfig get(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- the user's session information.channelId
- the channelId.transaction
- the transaction for persistence access.
PortalObjectNotFoundException
- if the channel was not found.
ManagerException
PortalException
void delete(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- transaction
-
ManagerException
PortalException
void update(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelConfig
- transaction
-
ManagerException
PortalException
String getPath(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- transaction
-
ManagerException
PortalException
String getPath(SessionConfig sessionConfig, String channelId, boolean localizable, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- localizable
- TODOtransaction
-
ManagerException
PortalException
String getFriendlyPath(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user. the identification of the
user.channelId
- the identification of the channel.transaction
- the transaction for persistence access.
ManagerException
PortalException
ChannelConfig.FRIENDLY_PATH_TYPE_CHANNEL_NAME
,
ChannelConfig.FRIENDLY_PATH_TYPE_INHERIT
,
ChannelConfig.FRIENDLY_PATH_TYPE_USER_DEFINED
List<String> getIdsByParentChannelId(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- transaction
-
ManagerException
PortalException
List<String> getPathIds(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- transaction
-
ManagerException
PortalException
void addCssLink(SessionConfig sessionConfig, String channelId, String cssId, int position, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- cssId
- position
- transaction
-
ManagerException
PortalException
void deleteCssLink(SessionConfig sessionConfig, String channelId, String cssId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- cssId
- transaction
-
ManagerException
PortalException
List<String> getCssIds(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- transaction
-
ManagerException
PortalException
List<String> getCssIdsRecursively(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- transaction
-
ManagerException
PortalException
List<String> getMetaTagIdsRecursively(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- channelId
- transaction
-
ManagerException
PortalException
boolean getCenterPages(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelConfig
- transaction
-
ManagerException
PortalException
int getLayoutPagesType(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) throws ManagerException, PortalException
The return would be one of PageConfig.PAGE_LAYOUT_INHERIT
,
PageConfig.PAGE_LAYOUT_WITH_TABLES
or PageConfig.PAGE_LAYOUT_WITH_TABLELESS
sessionConfig
- The session information of the user.channelConfig
- transaction
-
ManagerException
PortalException
int getCachePages(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelConfig
- transaction
-
ManagerException
PortalException
void serialize(SessionConfig sessionConfig, String channelId, OutputStream outputStream, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- outputStream
- transaction
-
ManagerException
PortalException
String deserialize(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node channelNode, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.deserializationConfig
- channelNode
- transaction
-
ManagerException
PortalException
void deserializeSecondPass(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node channelNode, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- user session information.deserializationConfig
- deserialization configuration.channelNode
- the data for the channel to be imported.transaction
- the transaction for persistence access.
ManagerException
PortalException
void serializeCss(SessionConfig sessionConfig, String channelId, OutputStream outputStream, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.channelId
- outputStream
- transaction
-
ManagerException
PortalException
void deserializeCss(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node cssLinksNodes, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- The session information of the user.deserializationConfig
- cssLinksNodes
- transaction
-
ManagerException
PortalException
List<String> getIdsByParentTemplateId(SessionConfig sessionConfig, String parentTemplateId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- parentTemplateId
- transaction
-
ManagerException
PortalException
void clearCache(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws ManagerException, PortalException
This method clears the following caches
If there are subchannels to which the user does not have access, these channels and their subchannels are skipped.
sessionConfig
- channelId
- transaction
-
ManagerException
PortalException
Collection<String> getIdsByPageTemplateId(SessionConfig sessionConfig, String pageTemplateId, ITransaction transaction) throws ManagerException, PortalException
sessionConfig
- pageTemplateId
- transaction
-
ManagerException
PortalException
String getPageTemplateIdRecursively(SessionConfig sessionConfig, String channelId, ITransaction transaction) throws PortalException
sessionConfig
- channelId
- transaction
-
PortalException
int getChannelTreeCount(String rootChannelId, ITransaction transaction) throws ManagerException, PortalException
rootChannelId
- root channel identifiertransaction
-
ManagerException
PortalException
List<String> getChannelTreeIds(String rootChannelId, ITransaction transaction) throws ManagerException, PortalException
rootChannelId
- root channel identifiertransaction
-
ManagerException
PortalException
List<String> getPathNames(SessionConfig sessionConfig, String channelId, boolean localizable, ITransaction transaction) throws ManagerException, PortalException
The first element of the list is the root portal channel followed by its children in hierarchical order.
sessionConfig
- session config of a userchannelId
- identifier of the channel for which you want the path nameslocalizable
- if true, the channel names are localizedtransaction
-
ManagerException
PortalException
int getProtocolType(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) throws ManagerException, PortalException
This method checks recursively up the channel´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
- channelConfig
- transaction
-
ManagerException
PortalException
@Deprecated String getRuntimeDataProviderClassName(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) throws PortalException
getPageWebResourceDataProviderClassName(SessionConfig, ChannelConfig, ITransaction)
.
sessionConfig
- current user sessionchannelConfig
- channel configurationtransaction
- current transaction
PortalException
String getPageWebResourceDataProviderClassName(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) throws PortalException
IPageWebResourceDataProvider
class name for the child pages of a channel.
This method recursively traverses up a channel tree starting from the given channel until the first channel that does not inherit the 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.channelConfig
- the channel.transaction
- the transaction for persistence access.
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |