Package de.espirit.firstspirit.access.store.pagestore

Interface PageFolder

All Superinterfaces:

Comparable<StoreElement>, HistoryProvider, IDProvider, StoreElement, StoreElementFolder, Workflowable

All Known Subinterfaces:

PageStoreRoot

public interface PageFolder
extends IDProvider, StoreElementFolder

This interface provides methods to handle the PageStore-folder

Since:

3.0

Nested Class Summary

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

HistoryProvider.RevisionProvider

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

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Field Summary

Fields

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

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

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

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

CHANGED, NEVER_RELEASED, RELEASED

Method Summary

Modifier and Type	Method	Description
Page	createPage(String name, Template pageTemplate)	Create a new Page in the current PageStore-folder based on the given PageTemplate.
Page	createPage(String uid, Template pageTemplate, boolean ensureUnique)	Create a new page in this folder with the given uid and template.
Page	createPage(String uid, Template pageTemplate, boolean ensureUnique, Map<Language,String> lang2DisplayName)	Create a new page in this folder with the given uid and template.
PageFolder	createPageFolder(String name)	Create a new PageStore-folder as a subfolder of the current.
PageFolder	createPageFolder(String uid, boolean ensureUnique)	Create a new PageFolder as child of this folder.
PageFolder	createPageFolder(String uid, Map<Language,String> lang2DisplayName, boolean ensureUnique)	Create a new PageFolder as child of this folder.
@NotNull String	getName()	Deprecated. since 4.1.10 - use IDProvider.getUid()

Methods inherited from interface java.lang.Comparable

compareTo

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

asRevisionProvider, getHistory, getHistory

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, 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, getPreviousSibling, 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

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

getColor, getTask, hasTask, removeTask, setColor, setTask

Field Details

UID_TYPE

static final IDProvider.UidType UID_TYPE

Uid type as returned by IDProvider.getUidType().

Since:

4.0.29

Method Details

createPageFolder

PageFolder createPageFolder(String name)
                     throws ElementDeletedException,
LockException

Create a new PageStore-folder as a subfolder of the current. Calls createPageFolder(name, true)

Parameters:

name - name of the new PageStore-folder

Returns:

PageStore-folder as an object

Throws:

ElementDeletedException

LockException

Since:

3.0

createPageFolder

PageFolder createPageFolder(String uid,
 boolean ensureUnique)
                     throws ElementDeletedException,
LockException,
DuplicateReferenceNameException

Create a new PageFolder as child of this folder.

Parameters:

uid - uid of the new PageFolder

ensureUnique - if false a DuplicateReferenceNameException may be thrown, if true a unique name will be created on the server if necessary

Returns:

PageFolder as an object

Throws:

LockException - if this folder is locked in another session

DuplicateReferenceNameException - if unifyNameOnServer is false and an element with the given uid in the same namescope already exists on the server

ElementDeletedException

Since:

4.0.34

createPageFolder

PageFolder createPageFolder(String uid,
 Map<Language,String> lang2DisplayName,
 boolean ensureUnique)
                     throws ElementDeletedException,
LockException,
DuplicateReferenceNameException

Create a new PageFolder as child of this folder.

Parameters:

uid - uid of the new PageFolder

lang2DisplayName - mapping of language to language specific displayname; used to create LanguageInfo nodes

ensureUnique - if false a DuplicateReferenceNameException may be thrown, if true a unique name will be created on the server if necessary

Returns:

PageFolder as an object

Throws:

LockException - if this folder is locked in another session

DuplicateReferenceNameException - if unifyNameOnServer is false and an element with the given uid in the same namescope already exists on the server

ElementDeletedException

Since:

4.0.34

createPage

Page createPage(String name,
 Template pageTemplate)
         throws ElementDeletedException,
LockException

Create a new Page in the current PageStore-folder based on the given PageTemplate. Same as createPage(uid, pageTemplate, false)

Parameters:

name - name of the new Page

pageTemplate - PageTemplate on which the new Page will be based

Returns:

Page as an object

Throws:

DuplicateReferenceNameException - if the given uid isn't unique

ElementDeletedException

LockException

Since:

3.0

createPage

Page createPage(String uid,
 Template pageTemplate,
 boolean ensureUnique)
         throws ElementDeletedException,
LockException

Create a new page in this folder with the given uid and template.

Parameters:

uid - uid of the page to be created

pageTemplate - template instance of the page to be created

ensureUnique - if false a DuplicateReferenceNameException may be thrown, if true a unique name will be created on the server if necessary

Returns:

new page

Throws:

LockException - if this pagefolder is locked in a different session

DuplicateReferenceNameException - if the given uid isn't unqique and unifyUid == false

ElementDeletedException

Since:

4.0.15

createPage

Page createPage(String uid,
 Template pageTemplate,
 boolean ensureUnique,
 Map<Language,String> lang2DisplayName)
         throws ElementDeletedException,
LockException

Create a new page in this folder with the given uid and template.

Parameters:

uid - uid of the page to be created

pageTemplate - template instance of the page to be created

ensureUnique - if false a DuplicateReferenceNameException may be thrown, if true a unique name will be created on the server if necessary

lang2DisplayName - mapping of language to language specific displayname; used to create LanguageInfo nodes

Returns:

new page

Throws:

LockException - if this pagefolder is locked in a different session

DuplicateReferenceNameException - if the given uid isn't unqique and unifyUid == false

ElementDeletedException

Since:

4.1.11

getName

@NotNull
@Deprecated
@NotNull String getName()

Deprecated.

since 4.1.10 - use IDProvider.getUid()

Get the unique name of the PageStore-folder

Specified by:

getName in interface StoreElement

Returns:

unique name of the PageStore-folder

Since:

3.0