lumis.portal.structure.sync.model.channel

Class Channel

java.lang.Object

lumis.portal.structure.sync.model.channel.Channel

All Implemented Interfaces:

Serializable, Cloneable, IFileElement, IFileStructureElement

public class Channel
extends Object
implements IFileStructureElement, Serializable, Cloneable

Channel model.

Documentation in this class focus synchronization behavior. About the use behind the fields in the portal, see ChannelConfig.

Since:

6.2.0

Version:

$Revision: 20617 $ $Date: 2017-10-13 17:58:47 +0000 (Fri, 13 Oct 2017) $

See Also:

ChannelConfig, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Channel.CenterPage
static class	Channel.ChannelType Enum for the type field.
static class	Channel.GroupOrderComparator Comparator used to order groups.
static class	Channel.LayoutPageType
static class	Channel.LogPathType Enum for the friendlyPathType field.
static class	Channel.PageWebResourceDataProviderType
static class	Channel.Protocol

Constructor Summary

Constructors

Constructor and Description
Channel()

Method Summary

Modifier and Type	Method and Description
protected Channel	clone() Returns a shallow clone of this channel.
Channel	cloneAndPostponeDependencies(Queue<AccessControlEntry> entriesToAdd, Queue<ParallelExecutor.IDatabaseTask> channelTemplateLinksToAdd) Creates a clone of this channel, without dependencies (which are postponed for add).
AccessControlList	getAccessControlList()
ChannelTemplateLink	getChannelTemplateLink()
List<ChannelCss>	getCsss()
String	getDirectoryChannelId() Returns the identifier of the channel that corresponds to the directory this element's file resides in.
SortedSet<Group>	getGroups()
String	getId() Returns the element's identifier.
List<MetaTag>	getMetaTags()
String	getName()
String	getParentId()
String	getParentTemplateId()
PropertyBag	getPropertyBag()
String	getStructureFileName() Returns the name of the structure file for this element.
boolean	isImplicitForeignKeysSet() Indicates whether the implicit foreign keys, set by setImplicitForeignKeys(String, String, String, String), have been set.
void	setFriendlyId(String friendlyId) Sets the friendly identifier for this structure element.
void	setImplicitForeignKeys(String accessControlListId, String parentAccessControlListId, String propertyBagId, String parentPropertyBagId) Sets the implicit foreign keys in this channel.
void	setParentId(String parentId)
void	setParentTemplateId(String parentTemplateId)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Channel

public Channel()

Method Detail

getMetaTags

public List<MetaTag> getMetaTags()

getCsss

public List<ChannelCss> getCsss()

getPropertyBag

public PropertyBag getPropertyBag()

getAccessControlList

public AccessControlList getAccessControlList()

getParentId

public String getParentId()

setParentId

public void setParentId(String parentId)

getParentTemplateId

public String getParentTemplateId()

setParentTemplateId

public void setParentTemplateId(String parentTemplateId)

getName

public String getName()

getGroups

public SortedSet<Group> getGroups()

getChannelTemplateLink

public ChannelTemplateLink getChannelTemplateLink()

cloneAndPostponeDependencies

public Channel cloneAndPostponeDependencies(Queue<AccessControlEntry> entriesToAdd,
                                            Queue<ParallelExecutor.IDatabaseTask> channelTemplateLinksToAdd)

Creates a clone of this channel, without dependencies (which are postponed for add).

Parameters:

entriesToAdd - the queue for the ACL entries to add.

channelTemplateLinksToAdd - the queue for the Channel Template Links to add.

Returns:

the clone.

Since:

6.2.0

clone

protected Channel clone()

Returns a shallow clone of this channel.

Overrides:

clone in class Object

Returns:

the clone.

isImplicitForeignKeysSet

public boolean isImplicitForeignKeysSet()

Indicates whether the implicit foreign keys, set by setImplicitForeignKeys(String, String, String, String), have been set.

Returns:

true if the implicit foreign keys are set, false otherwise.

Since:

6.2.0

setImplicitForeignKeys

public void setImplicitForeignKeys(String accessControlListId,
                                   String parentAccessControlListId,
                                   String propertyBagId,
                                   String parentPropertyBagId)

Sets the implicit foreign keys in this channel. Required before it can be properly persisted to the database.

Parameters:

accessControlListId - the identifier for this channel's ACL. Must be null if the channel will be added (will be auto-generated).

parentAccessControlListId - the identifier of the parent of this channel's ACL.

propertyBagId - the identifier for this channel's property bag. Must be null if the channel will be added. (will be auto-generated).

parentPropertyBagId - the identifier for the parent of this channel's property bag.

Since:

6.2.0

getId

public String getId()

Description copied from interface: IFileStructureElement

Returns the element's identifier.

Specified by:

getId in interface IFileStructureElement

Returns:

the element's identifier.

getDirectoryChannelId

public String getDirectoryChannelId()

Description copied from interface: IFileStructureElement

Returns the identifier of the channel that corresponds to the directory this element's file resides in.

Specified by:

getDirectoryChannelId in interface IFileStructureElement

Returns:

the identifier of the channel.

getStructureFileName

public String getStructureFileName()

Description copied from interface: IFileStructureElement

Returns the name of the structure file for this element.

Specified by:

getStructureFileName in interface IFileStructureElement

Returns:

the structure file name (only the file's name, does not include any path).

setFriendlyId

public void setFriendlyId(String friendlyId)

Description copied from interface: IFileStructureElement

Sets the friendly identifier for this structure element.

Specified by:

setFriendlyId in interface IFileStructureElement

Parameters:

friendlyId - the friendly identifier.