lumis.portal.structure.sync
Class ChannelResume

java.lang.Object
  lumis.portal.structure.sync.ChannelResume

All Implemented Interfaces:

IFileElement, IFileStructureElement

public class ChannelResume
extends Object
implements IFileStructureElement

Resumed information about a channel. Composes a ChannelHierarchy.

Since:

6.2.0

Constructor Summary

ChannelResume()

Method Summary

String	getAccessControlListId() Returns the identifier of this channel's ACL.
ChannelTemplateLinkInfo	getChannelTemplateLinkInfo() Returns information of the channel template element this channel is linked to.
String	getDirectoryChannelId() Returns the identifier of the channel that corresponds to the directory this element's file resides in.
String	getFriendlyId()
String	getId() Returns this channel's identifier.
ChannelResume	getParentChannel() Returns the channel parent of this channel.
String	getPath() Returns the relative path to this channel's directory.
String	getPropertyBagId() Returns the identifier of this channel's property bag.
String	getStructureFileName() Returns the name of the structure file for this element.
String	getStructureFilePath() Returns the relative path to this channel structure file.
IWebsite	getWebsite() Returns the website this channel belongs to.
boolean	isKeptUnchanged() Returns whether this channel was kept unchanged during a synchronization.
boolean	isRecursivelySelectedForSynchronization() Returns whether this channel is selected for recursive synchronization.
boolean	isSelectedForSynchronization() Returns whether this channel is selected for synchronization.
void	keptUnchanged() Mark this channel as it was kept unchanged.
void	setFriendlyId(String friendlyId) Sets the friendly identifier for this structure element.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelResume

public ChannelResume()

Method Detail

getId

public String getId()

Returns this channel's identifier.

Specified by:

getId in interface IFileStructureElement

Returns:

the identifier.

Since:

6.2.0

getParentChannel

public ChannelResume getParentChannel()

Returns the channel parent of this channel.

Returns:

the parent channel.

Since:

6.2.0

getChannelTemplateLinkInfo

public ChannelTemplateLinkInfo getChannelTemplateLinkInfo()

Returns information of the channel template element this channel is linked to.

Returns:

the channel template link information.

Since:

6.2.0

getAccessControlListId

public String getAccessControlListId()

Returns the identifier of this channel's ACL.

Returns:

the ACL identifier.

Since:

6.2.0

getPropertyBagId

public String getPropertyBagId()

Returns the identifier of this channel's property bag.

Returns:

the property bag identifier.

Since:

6.2.0

getWebsite

public IWebsite getWebsite()

Returns the website this channel belongs to. This property is set by ChannelHierarchy.detectWebsites().

Returns:

the website.

Since:

6.2.0

isKeptUnchanged

public boolean isKeptUnchanged()

Returns whether this channel was kept unchanged during a synchronization. Refers only to the corresponding Channel entity, not to any related entity.

Returns:

true if it was kept unchanged, false otherwise.

Since:

6.2.0

keptUnchanged

public void keptUnchanged()

Mark this channel as it was kept unchanged.

Since:

6.2.0

See Also:

isKeptUnchanged()

isSelectedForSynchronization

public boolean isSelectedForSynchronization()

Returns whether this channel is selected for synchronization. Takes into account selection implied from ancestral channels.

Returns:

true if this channel is selected for synchronization, false otherwise.

Since:

6.2.0

isRecursivelySelectedForSynchronization

public boolean isRecursivelySelectedForSynchronization()

Returns whether this channel is selected for recursive synchronization. Takes into account selection implied from ancestral channels.

Returns:

true if this channel is selected for recursive synchronization, false otherwise.

Since:

6.2.0

getPath

public String getPath()

Returns the relative path to this channel's directory.

Returns:

the path to this channel's directory, relative to the structure root.

Since:

6.2.0

getStructureFilePath

public String getStructureFilePath()

Returns the relative path to this channel structure file.

Returns:

the path to this channel's structure file, relative to the structure root.

Since:

6.2.0

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.

getFriendlyId

public String getFriendlyId()