lumis.portal.channel

Interface IChannelManagerSPI

All Superinterfaces:

IChannelManager, IConfigKeyChecker

All Known Implementing Classes:

ChannelManager

public interface IChannelManagerSPI
extends IChannelManager

Manager responsible for channel-related internal operations.

Since:

6.0.0

Version:

$Revision: 22201 $ $Date: 2018-12-17 17:53:06 +0000 (Mon, 17 Dec 2018) $

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IChannelManagerSPI.IgnoreOnExportImportResult Ignored channel on export and import search result.

Method Summary

Modifier and Type	Method and Description
List<String>	getChannelTreeIds(String rootChannelId, boolean includeIgnoredOnImportExportChannels, ITransaction transaction) Returns all the ids of channels in the tree for which the root is the given channelId.
boolean	isGoogleAnalyticsEnabled(ChannelConfig channelConfig) Returns whether the Google Analytics is enable in the given channel.
Boolean	isGoogleAnalyticsEnabledLocal(ChannelConfig channelConfig) Returns whether the Google Analytics is enable in the given channel or null if this property is inherited.
IChannelManagerSPI.IgnoreOnExportImportResult	isIgnoreOnExportImport(SessionConfig sessionConfig, String channelId, ITransaction transaction) Returns the result of a given channel ignoring.
void	setGoogleAnalyticsEnable(Boolean enabled, ChannelConfig channelConfig) Sets whether the Google Analytics is enable in the given channel.
void	updateLocalGroupPrefixFromFriendlyId(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) Updates the local group prefix of the given channel with its friendly identifier.
void	validateFriendlyId(SessionConfig sessionConfig, ChannelConfig channelConfig, ITransaction transaction) Validates the channel's friendly identifier.

Methods inherited from interface lumis.portal.channel.IChannelManager

add, addCssLink, addOrUpdate, clearCache, copy, delete, deleteCssLink, deserialize, deserializeCss, deserializeSecondPass, get, getCachePages, getCenterPages, getChannelTreeCount, getChannelTreeIds, getCssIds, getCssIdsRecursively, getFriendlyPath, getIdsByPageTemplateId, getIdsByParentChannelId, getIdsByParentTemplateId, getLayoutPagesType, getMetaTagIdsRecursively, getPageTemplateIdRecursively, getPageWebResourceDataProviderClassName, getPath, getPath, getPathIds, getPathNames, getProtocolType, getRuntimeDataProviderClassName, isInsideChannelTemplate, serialize, serializeCss, update

Methods inherited from interface lumis.portal.serialization.operation.IConfigKeyChecker

keyExists

Method Detail

validateFriendlyId

void validateFriendlyId(SessionConfig sessionConfig,
                        ChannelConfig channelConfig,
                        ITransaction transaction)
                 throws PortalException

Validates the channel's friendly identifier. If the validation is not successful, an exception is thrown.

Parameters:

sessionConfig - the user's session information.

channelConfig - the channel to be validated.

transaction - the transaction to use.

Throws:

PortalException

Since:

6.0.0

isIgnoreOnExportImport

IChannelManagerSPI.IgnoreOnExportImportResult isIgnoreOnExportImport(SessionConfig sessionConfig,
                                                                     String channelId,
                                                                     ITransaction transaction)
                                                              throws PortalException

Returns the result of a given channel ignoring.

Parameters:

sessionConfig - the user's session.

channelId - the channel identifier.

transaction - the transaction.

Returns:

the result of a given channel ignoring.

Throws:

PortalException

Since:

8.0.0

getChannelTreeIds

List<String> getChannelTreeIds(String rootChannelId,
                               boolean includeIgnoredOnImportExportChannels,
                               ITransaction transaction)
                        throws ManagerException,
                               PortalException

Returns all the ids of channels in the tree for which the root is the given channelId.

Parameters:

rootChannelId - root channel identifier.

includeIgnoredOnImportExportChannels - indicates whether the ignored channels on export and import should be ignored.

transaction - the transaction.

Returns:

all the ids of channels in the tree for which the root is the given channelId.

Throws:

ManagerException

PortalException

Since:

8.0.0

isGoogleAnalyticsEnabledLocal

Boolean isGoogleAnalyticsEnabledLocal(ChannelConfig channelConfig)
                               throws PortalException

Returns whether the Google Analytics is enable in the given channel or null if this property is inherited.

Parameters:

channelConfig - the channel the information will be read from.

Returns:

whether the Google Analytics is enable in the given channel or null if this property is inherited.

Throws:

PortalException

Since:

8.2.0

isGoogleAnalyticsEnabled

boolean isGoogleAnalyticsEnabled(ChannelConfig channelConfig)
                          throws PortalException

Returns whether the Google Analytics is enable in the given channel.

Parameters:

channelConfig - the channel the information will be read from.

Returns:

whether the Google Analytics is enable in the given channel.

Throws:

PortalException

Since:

8.2.0

setGoogleAnalyticsEnable

void setGoogleAnalyticsEnable(Boolean enabled,
                              ChannelConfig channelConfig)
                       throws PortalException

Sets whether the Google Analytics is enable in the given channel.

Parameters:

enabled - the value or null to indicate the value should be inherited.

channelConfig - the channel the information will be set to.

Throws:

PortalException

Since:

8.2.0

updateLocalGroupPrefixFromFriendlyId

void updateLocalGroupPrefixFromFriendlyId(SessionConfig sessionConfig,
                                          ChannelConfig channelConfig,
                                          ITransaction transaction)
                                   throws ManagerException,
                                          PortalException

Updates the local group prefix of the given channel with its friendly identifier. If other channel already uses that local group prefix, a numeric suffix will be appended to the friendly identifier to generate a unique local group prefix.
This method is atomic. Thus, it will use its own transaction.

Parameters:

sessionConfig - the user's session information.

channelConfig - the channel to be updated.

transaction - the transaction.

Throws:

ManagerException

PortalException

Since:

11.1.0