lumis.portal.structure.sync.model.page
Class Page

java.lang.Object
  lumis.portal.structure.sync.model.page.Page

All Implemented Interfaces:

Serializable, IFileElement, IFileStructureElement

public class Page
extends Object
implements IFileStructureElement, Serializable

Page model.

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

Since:

6.2.0

See Also:

PageConfig, Serialized Form

Nested Class Summary

static class	Page.CenterPageType
static class	Page.PageCacheType
static class	Page.PageLayoutType
static class	Page.PageProtocolType
static class	Page.PageWebResourceDataProviderType

Constructor Summary

Page()

Method Summary

AccessControlList	getAccessControlList()
String	getChannelId()
List<PageCss>	getCsss()
String	getDirectoryChannelId() Returns the identifier of the channel that corresponds to the directory this element's file resides in.
String	getId() Returns the element's identifier.
SortedSet<InterfaceInstance>	getInterfaceInstances()
List<MetaTag>	getMetaTags()
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 page.

Methods inherited from class java.lang.Object

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

Constructor Detail

Page

public Page()

Method Detail

getChannelId

public String getChannelId()

getInterfaceInstances

public SortedSet<InterfaceInstance> getInterfaceInstances()

getAccessControlList

public AccessControlList getAccessControlList()

getMetaTags

public List<MetaTag> getMetaTags()

getCsss

public List<PageCss> getCsss()

getPropertyBag

public PropertyBag getPropertyBag()

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 page. Required before it can be properly persisted to the database.

Parameters:

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

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

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

parentPropertyBagId - the identifier for the parent of this page'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.