public interface PageFolder extends IDProvider, StoreElementFolder
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static IDProvider.UidType |
UID_TYPE
Uid type as returned by
IDProvider.getUidType() . |
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Modifier and Type | Method and 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.
|
String |
getName()
Deprecated.
since 4.1.10 - use
IDProvider.getUid() |
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
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
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
static final IDProvider.UidType UID_TYPE
IDProvider.getUidType()
.PageFolder createPageFolder(String name) throws ElementDeletedException, LockException
createPageFolder(name, true)
name
- name of the new PageStore-folderElementDeletedException
LockException
PageFolder createPageFolder(String uid, boolean ensureUnique) throws ElementDeletedException, LockException, DuplicateReferenceNameException
uid
- uid of the new PageFolderensureUnique
- if false
a DuplicateReferenceNameException
may be thrown, if
true
a unique name will be created on the server if necessaryLockException
- if this folder is locked in another sessionDuplicateReferenceNameException
- if unifyNameOnServer is false
and an element with the given uid in the same namescope already exists on the serverElementDeletedException
PageFolder createPageFolder(String uid, Map<Language,String> lang2DisplayName, boolean ensureUnique) throws ElementDeletedException, LockException, DuplicateReferenceNameException
uid
- uid of the new PageFolderlang2DisplayName
- mapping of language to language specific displayname; used to create LanguageInfo
nodesensureUnique
- if false
a DuplicateReferenceNameException
may be thrown, if
true
a unique name will be created on the server if necessaryLockException
- if this folder is locked in another sessionDuplicateReferenceNameException
- if unifyNameOnServer is false
and an element with the given uid in the same namescope already exists on the serverElementDeletedException
Page createPage(String name, Template pageTemplate) throws ElementDeletedException, LockException
createPage(uid, pageTemplate, false)
name
- name of the new PagepageTemplate
- PageTemplate on which the new Page will be basedDuplicateReferenceNameException
- if the given uid isn't uniqueElementDeletedException
LockException
Page createPage(String uid, Template pageTemplate, boolean ensureUnique) throws ElementDeletedException, LockException
uid
- uid of the page to be createdpageTemplate
- template instance of the page to be createdensureUnique
- if false
a DuplicateReferenceNameException
may be thrown, if
true
a unique name will be created on the server if necessaryLockException
- if this pagefolder is locked in a different sessionDuplicateReferenceNameException
- if the given uid isn't unqique and unifyUid == false
ElementDeletedException
Page createPage(String uid, Template pageTemplate, boolean ensureUnique, Map<Language,String> lang2DisplayName) throws ElementDeletedException, LockException
uid
- uid of the page to be createdpageTemplate
- template instance of the page to be createdensureUnique
- if false
a DuplicateReferenceNameException
may be thrown, if
true
a unique name will be created on the server if necessarylang2DisplayName
- mapping of language to language specific displayname; used to create LanguageInfo
nodesLockException
- if this pagefolder is locked in a different sessionDuplicateReferenceNameException
- if the given uid isn't unqique and unifyUid == false
ElementDeletedException
@NotNull @Deprecated String getName()
IDProvider.getUid()
getName
in interface StoreElement
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210