de.espirit.firstspirit.access.store.pagestore

Interface Page

All Superinterfaces:

Comparable<StoreElement>, ContentProducer, DataProvider, HistoryProvider, IDProvider, PackagePoolItem, Previewable, StoreElement, TemplateProvider<PageTemplate>, Workflowable

All Known Subinterfaces:

GCAPage

public interface Page
extends DataProvider, IDProvider, ContentProducer, TemplateProvider<PageTemplate>, Previewable, PackagePoolItem

This interface provides methods to handle the Pages in the PageStore

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 IDProvider.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
void	addTranslated(Language language) Adds the given language to the list of translated languages.
Body	getBodyByName(String bodyName) Searches for the body with the given name in this page.
String	getName() Deprecated. since 4.1.10 - use IDProvider.getUid()
PageTemplate	getTemplate() Returns the template of this element.
boolean	isArchivePage() Generate archived version of this page
boolean	isTranslated(Language language) Tests if this page is translated for the given language.
void	removeTranslated(Language language) Removes the given language from the list of translated languages.
void	setArchive(boolean archive) Set generate archived version of this page.
void	setTemplate(PageTemplate pageTemplate) Set the template for this page.

Methods inherited from interface de.espirit.firstspirit.access.store.pagestore.DataProvider

clearCachedData, getData, getFormData, setData, setFormData

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

createContent, getExtension, getFilename, getMultiPageParams, getStoredUrl, getUrl

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

getPreviewUrl, getPreviewUrlObject

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, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, 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, getReferenceName, 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, 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 IDProvider.getUidType().

Since:

4.0.43

Method Detail

getName

@NotNull
@Deprecated
String getName()

Deprecated. since 4.1.10 - use IDProvider.getUid()

Get the unique name of the Page

Specified by:

getName in interface StoreElement

Returns:

unique name of the Page

Since:

3.0

getTemplate

@NotNull
PageTemplate getTemplate()

Returns the template of this element.

Specified by:

getTemplate in interface TemplateProvider<PageTemplate>

Returns:

the template of type

Since:

3.0

setTemplate

void setTemplate(@NotNull
               PageTemplate pageTemplate)

Set the template for this page.

Parameters:

pageTemplate - template this page should base on

Throws:

NullPointerException - if pageTemplate is null

Since:

4.1.25

getBodyByName

Body getBodyByName(String bodyName)

Searches for the body with the given name in this page.

Parameters:

bodyName - - the name of the body

Returns:

Body - the body or null if no body exists with the given name

Since:

3.0

isArchivePage

boolean isArchivePage()

Generate archived version of this page

Returns:

should archived versions be generated

Since:

3.0

setArchive

void setArchive(boolean archive)

Set generate archived version of this page.

Parameters:

archive - Generate archived version of this page

Since:

3.0

addTranslated

void addTranslated(Language language)

Adds the given language to the list of translated languages.

Parameters:

language - Language to add

Since:

3.0

removeTranslated

void removeTranslated(Language language)

Removes the given language from the list of translated languages.

Parameters:

language - Language to remove

Since:

3.0

isTranslated

boolean isTranslated(Language language)

Tests if this page is translated for the given language.

Parameters:

language - Language to check translation for

Returns:

true if this page is translated for the given language

Since:

3.0