de.espirit.firstspirit.access.store.sitestore

Interface PageRef

All Superinterfaces:

Comparable<StoreElement>, ContentProducer, HistoryProvider, IDProvider, PackagePoolItem, Previewable, Referenceable, StartNode, StoreElement, Workflowable

public interface PageRef
extends StartNode, Referenceable, Previewable, ContentProducer, PackagePoolItem

This interface provides methods to handle the pagereferences in the SiteStore

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider

HistoryProvider.RevisionProvider

Field Summary

Fields

Modifier and Type	Field and Description
static IDProvider.UidType	UID_TYPE Uid type as returned by getUidType().

Fields inherited from interface de.espirit.firstspirit.access.store.Previewable

PARAM_REVISION, PREVIEWMODE_DEFAULT, PREVIEWMODE_DEFAULT_REFRESH, PREVIEWMODE_FORCE_REFRESH, PREVIEWMODE_FULL_QUALIFIED, PREVIEWMODE_NONE, PREVIEWMODE_SSO, PREVIEWMODE_WEBEDIT, PREVIEWMODE_WEBEDIT_FULL_QUALIFIED, PREVIEWMODE_WITHOUT_CONTEXTNAME

Fields inherited from interface de.espirit.firstspirit.access.store.PackagePoolItem

BLOCKED, MODIFIED, UNMODIFIED

Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider

CHANGED, NEVER_RELEASED, RELEASED

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

Method Summary

Methods

Modifier and Type	Method and Description
Content2Params	getContent2Params()
String	getFilename() Returns a filename suggestions which may be used for creating urls.
String	getName() Deprecated. since 4.1.10 - use getUid()
Page	getPage() Get the page from Page-Store of the current pagereference as object
PageGroup	getPageGroup() Get the page-group of the current pagereference as object
int	getPageGroupPosition() Get the position-number of the current pagereference in the pagegroup
long	getPageId()
PageLangSpec	getPageLangSpec(Language language) Get the pagereference specification for the given language
SiteStoreFolder	getParentFolder()
String	getUid() Get the unique referenec name of the pagereference.
IDProvider.UidType	getUidType() Return UID_TYPE.
void	save() Saves the node and all childs, shortcut for save(null, true).
void	setFilename(String filename) Set a filename suggestions which may be used for creating urls.
void	setPage(Page page) Set the page of the pagereference
void	setPageGroup(PageGroup group) Set the page-group of the pagereference

Methods inherited from interface de.espirit.firstspirit.access.store.sitestore.StartNode

isStartNode

Methods inherited from interface de.espirit.firstspirit.access.store.Referenceable

getReferenceName

Methods inherited from interface de.espirit.firstspirit.access.store.Previewable

getPreviewUrl, getPreviewUrlObject

Methods inherited from interface de.espirit.firstspirit.access.store.ContentProducer

createContent, getExtension, getMultiPageParams, getStoredUrl, getUrl

Methods inherited from interface de.espirit.firstspirit.access.store.PackagePoolItem

addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, setInheritWorkflowPermission, setLock, setLock, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, update

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider

asRevisionProvider, getHistory, getHistory

Field Detail

UID_TYPE

static final IDProvider.UidType UID_TYPE

Uid type as returned by getUidType().

Since:

4.0.24

Method Detail

getName

@NotNull
@Deprecated
String getName()

Deprecated. since 4.1.10 - use getUid()

Specified by:

getName in interface StoreElement

Since:

3.0

getPageId

long getPageId()

Returns:

the id of the referenced page

Since:

3.1.172

See Also:

getPage()

getPage

@Nullable
Page getPage()

Get the page from Page-Store of the current pagereference as object

Returns:

page of the reference

Since:

3.0

setPage

void setPage(Page page)

Set the page of the pagereference

Parameters:

page - new page of the pagereference

Since:

3.0

getPageGroupPosition

int getPageGroupPosition()

Get the position-number of the current pagereference in the pagegroup

Returns:

position-number of the pagereference in the pagegroup

Since:

3.0

getPageGroup

@Nullable
PageGroup getPageGroup()

Get the page-group of the current pagereference as object

Returns:

page-group of the pagereference

Since:

3.0

setPageGroup

void setPageGroup(PageGroup group)

Set the page-group of the pagereference

Parameters:

group - new page-group of the pagereference

Throws:

LockException - occurs if this node already locked by another user

Since:

3.0

getPageLangSpec

PageLangSpec getPageLangSpec(Language language)

Get the pagereference specification for the given language

Returns:

specification of the pagereference as object

Since:

3.0

getContent2Params

@Nullable
Content2Params getContent2Params()

Returns:

the content parameter object or null if the corresponding page has a new content section.

Since:

3.1.158

getUidType

@NotNull
IDProvider.UidType getUidType()

Return UID_TYPE.

Specified by:

getUidType in interface IDProvider

Returns:

the unique identifier

Since:

4.0.24

See Also:

IDProvider.hasUid()

getUid

@NotNull
String getUid()

Get the unique referenec name of the pagereference.

To use in a CMS_REF statement, the identifier must be prefixed with "pageref:".

Specified by:

getUid in interface IDProvider

Returns:

uniquedescription the reference name

Since:

4.0

See Also:

IDProvider.setUid(String)

getFilename

@ApiDoc(comment="A filename suggestions which may be used for creating urls",
        since="3.0")
@NotNull
String getFilename()

Returns a filename suggestions which may be used for creating urls.

Specified by:

getFilename in interface ContentProducer

Returns:

a filename suggestion

Since:

3.0

See Also:

setFilename(String)

setFilename

void setFilename(String filename)

Set a filename suggestions which may be used for creating urls.

Since:

3.0

See Also:

getFilename()

getParentFolder

SiteStoreFolder getParentFolder()

Since:

3.0

save

void save()

Description copied from interface: StoreElement

Saves the node and all childs, shortcut for save(null, true).

Use StoreElement.isLockSupported() to check if save operation is supported.

Specified by:

save in interface StoreElement

Throws:

DuplicateReferenceNameException - if a page ref with this getUid() already exists on the server

Since:

3.0

See Also:

StoreElement.save(String)