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

Version:

$Revision: 17047 $ $Date: 2015-03-03 14:22:22 +0000 (Tue, 03 Mar 2015) $

Constructor Summary

Constructors

Constructor and Description
ChannelResume()

Method Summary

Modifier and Type	Method and Description
boolean	belongsToComponent() Indicates whether this channel belongs to a component.
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(boolean isSyncOut) 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(boolean isSyncOut) Returns the relative path to this channel structure file.
IWebsite	getWebsite() Returns the website this channel belongs to.
boolean	isIgnoreOnExportImport() Returns whether this channel will be ignored on export and import.
boolean	isIgnoreOnExportImport(Map<String,ChannelResume> allChannels) Returns whether this channel will be ignored on export and import based on the all channels map.
boolean	isKeepParentId() Indicates whether the parent channel id of the related channel should be kept during sync out.
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.
boolean	isStructureRoot() Returns whether this is a structure's root.
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

isKeepParentId

public boolean isKeepParentId()

Indicates whether the parent channel id of the related channel should be kept during sync out.

Returns:

whether the parent channel id of the related channel should be kept during sync out.

Since:

7.1.0

isIgnoreOnExportImport

public boolean isIgnoreOnExportImport()

Returns whether this channel will be ignored on export and import.

Returns:

whether this channel will be ignored on export and import.

Since:

8.0.0

isIgnoreOnExportImport

public boolean isIgnoreOnExportImport(Map<String,ChannelResume> allChannels)

Returns whether this channel will be ignored on export and import based on the all channels map.

Returns:

whether this channel will be ignored on export and import based on the all channels map.

Since:

8.0.0

getPath

public String getPath(boolean isSyncOut)

Returns the relative path to this channel's directory.

Parameters:

isSyncOut - indicates whether is is an export process.

Returns:

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

Since:

7.1.0

getStructureFilePath

public String getStructureFilePath(boolean isSyncOut)

Returns the relative path to this channel structure file.

Parameters:

isSyncOut - indicates whether is is an export process.

Returns:

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

Since:

7.1.0

belongsToComponent

public boolean belongsToComponent()

Indicates whether this channel belongs to a component. It belongs to a component if it is a component channel root or a channel descendant of a component channel root.

Returns:

true if this channel belongs to a component; false otherwise.

Since:

8.0.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()

isStructureRoot

public boolean isStructureRoot()

Returns whether this is a structure's root.

Returns:

whether this is a structure's root.

Since:

7.1.0