de.espirit.firstspirit.access.store.sitestore

Interface SiteStoreFolder

All Superinterfaces:

Comparable<StoreElement>, DataProvider, HistoryProvider, IDProvider, StartNode, StoreElement, Workflowable

All Known Subinterfaces:

PageRefFolder, SiteStoreRoot

public interface SiteStoreFolder
extends StartNode, DataProvider

Since:

3.0

Example:

Example how to modify variables of SiteStoreFolder

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.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
DocumentGroup	createDocumentGroup(String uid, boolean unifyNameOnServer) Creates a new document group in this folder.
PageGroup	createPageGroup(String name) Create a new page-group for the current PageReference.
PageRef	createPageRef(String uid, Page page) Create a new page reference entry.
PageRef	createPageRef(String uid, Page page, boolean unifyNameOnServer) Creates a new page reference in this folder.
PageRef	createPageRef(String uid, Page page, Map<Language,String> lang2DisplayName, boolean unifyNameOnServer) Creates a new page reference in this folder.
PageRefFolder	createPageRefFolder(String uid) Create a new SiteStore-folder in this folder.
PageRefFolder	createPageRefFolder(String uid, boolean unifyNameOnServer) Create a new PageRefFolder as child of this folder.
PageRefFolder	createPageRefFolder(String uid, Map<Language,String> lang2DisplayName, boolean unifyNameOnServer) Create a new PageRefFolder as child of this folder.
PageRefFolder	createPageRefFolder(String uid, Map<Language,String> lang2DisplayName, boolean unifyNameOnServer, IDProvider nextSibling) Create a new PageRefFolder as child of this folder and place it before the given next sibling.
void	deletePageGroup(PageGroup pageGroup) Delete the given page-group for the current PageReference
StartNode	findStartNode() Finds recursive the start node in this sub tree.
SiteStoreVariableFormData	getFormData() Gets a form data container containing containig all defined sitestore variables.
PageGroup[]	getPageGroups() Get the list of the page-groups for the current PageReference
SiteStoreFolder	getParentFolder() Get the parent folder.
StartNode	getStartNode() Returns the startnode of this folder which is a direct child of this folder or null if no start node is defined.
String	getStoredUrl(Language language, TemplateSet templateSet) Get the stored URL for this node and the provided combination of language and template set.
boolean	isFolder() All implementing classes must return true.
void	setStartNode(StartNode startNode) Sets the given StartNode as startnode of this sitestore folder.

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

isStartNode

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

clearCachedData, getData, setData, setFormData

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, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, 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

getParentFolder

@Nullable
SiteStoreFolder getParentFolder()

Get the parent folder.

Returns:

an instance of SiteStoreRoot or PageRefFolder, or null if the folder is not part of the tree or the root node

Since:

3.0

isFolder

boolean isFolder()

All implementing classes must return true.

Specified by:

isFolder in interface StoreElement

Returns:

true

Since:

3.0

getStartNode

StartNode getStartNode()

Returns the startnode of this folder which is a direct child of this folder or null if no start node is defined.

Returns:

The defined startnode or null if no start node is defined.

Since:

4.0.27

See Also:

setStartNode(StartNode), findStartNode()

setStartNode

void setStartNode(StartNode startNode)

Sets the given StartNode as startnode of this sitestore folder.

Parameters:

startNode - The node to set as start node.

Since:

4.0.27

See Also:

getStartNode()

findStartNode

StartNode findStartNode()

Finds recursive the start node in this sub tree. This may return null, e.g. in case this is an empty folder.
The returned node (if not null) is instance of PageRef or DocumentGroup and may not be a direct child of this folder.

Returns:

A PageRef or a DocumentGroup or null.

Since:

4.0.27

See Also:

getStartNode()

createPageRefFolder

PageRefFolder createPageRefFolder(String uid)
                                  throws LockException,
                                         ElementDeletedException

Create a new SiteStore-folder in this folder. Short for createPageRefFolder(name, false).

Parameters:

uid - uid of the new SiteStore-folder

Returns:

SiteStore-folder as an object

Throws:

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

LockException - If the folder is locked by another session.

ElementDeletedException - If the current node has been deleted.

Since:

3.0

createPageRefFolder

PageRefFolder createPageRefFolder(String uid,
                                boolean unifyNameOnServer)
                                  throws LockException,
                                         DuplicateReferenceNameException,
                                         ElementDeletedException

Create a new PageRefFolder as child of this folder.

Parameters:

uid - uid of the new PageRefFolder

unifyNameOnServer - if false a DuplicateReferenceNameException may be thrown, if true the name will be unified on the server if necessary

Returns:

SiteStore-folder as an object

Throws:

LockException - if this folder is locked in another session

DuplicateReferenceNameException - if an element with the given uid in the same namescope already exits on the server

ElementDeletedException - if this folder is already deleted on the server

Since:

4.0

createPageRefFolder

PageRefFolder createPageRefFolder(String uid,
                                Map<Language,String> lang2DisplayName,
                                boolean unifyNameOnServer)
                                  throws LockException,
                                         DuplicateReferenceNameException,
                                         ElementDeletedException

Create a new PageRefFolder as child of this folder.

Parameters:

uid - uid of the new PageRefFolder

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

unifyNameOnServer - if false a DuplicateReferenceNameException may be thrown, if true the name will be unified on the server if necessary

Returns:

SiteStore-folder 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 exits on the server

ElementDeletedException - if this folder is already deleted on the server

Since:

4.0

createPageRefFolder

@NotNull
PageRefFolder createPageRefFolder(String uid,
                                        Map<Language,String> lang2DisplayName,
                                        boolean unifyNameOnServer,
                                        IDProvider nextSibling)
                                  throws LockException,
                                         DuplicateReferenceNameException,
                                         ElementDeletedException

Create a new PageRefFolder as child of this folder and place it before the given next sibling. If no next sibling is given or the given one is no child of this folder, the new child will be appended.

Parameters:

uid - The uid of the new PageRefFolder

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

unifyNameOnServer - if false a DuplicateReferenceNameException may be thrown, if true the name will be unified on the server if necessary

nextSibling - A sibling to add the new child before in order or null to append the new child.

Returns:

SiteStore-folder 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 exits on the server

ElementDeletedException - if this folder is already deleted on the server

Since:

5.0.11

createPageRef

PageRef createPageRef(String uid,
                    Page page)
                      throws DuplicateReferenceNameException,
                             LockException,
                             ElementDeletedException

Create a new page reference entry.

Parameters:

uid - uid of the new pageref

page - page to which the new reference will be linked

Returns:

the new created page ref instance

Throws:

LockException - if this folder is locked in another session

DuplicateReferenceNameException - if there is already an element with the specified uid in the same namescope on the server

ElementDeletedException - if this folder is already deleted on the server

Since:

3.0

createPageRef

PageRef createPageRef(String uid,
                    Page page,
                    boolean unifyNameOnServer)
                      throws LockException,
                             ElementDeletedException

Creates a new page reference in this folder. The given name is used as suggestion if unifyNameOnServer == true and will be unified on the server if it is necessary.

Parameters:

uid - of the new page ref

page - page to which the new reference will be linked

unifyNameOnServer - if true the given uid will be unified on server if necessary, otherwise a DuplicateReferenceNameException will be thrown, if a pageref with the given uid already exists on the server

Returns:

the new created page ref instance

Throws:

LockException - if this folder is locked in another session

DuplicateReferenceNameException - if a pageref with the given uid already exists on the server

ElementDeletedException - if this folder is already deleted on the server

Since:

4.0

createPageRef

PageRef createPageRef(String uid,
                    Page page,
                    Map<Language,String> lang2DisplayName,
                    boolean unifyNameOnServer)
                      throws LockException,
                             ElementDeletedException

Creates a new page reference in this folder.
The given uid is used as suggestion. If unifyNameOnServer == true the given uid will be unified on server if necessary, otherwise a DuplicateReferenceNameException will be thrown, if a pageref with the given uid already exists on the server.

Parameters:

uid - of the new page ref

page - page to which the new reference will be linked

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

unifyNameOnServer - if true the given uid will be unified on server if necessary, otherwise a DuplicateReferenceNameException will be thrown, if a pageref with the given uid already exists on the server

Returns:

the new created page ref instance

Throws:

LockException - if this folder is locked in another session

DuplicateReferenceNameException - if unifyNameOnServer is false and a pageref with the given uid exists on the server

ElementDeletedException - if this folder is already deleted on the server

Since:

4.2.400

createDocumentGroup

DocumentGroup createDocumentGroup(String uid,
                                boolean unifyNameOnServer)
                                  throws LockException,
                                         DuplicateReferenceNameException,
                                         LicenseException,
                                         ElementDeletedException

Creates a new document group in this folder. The given uid is used as suggestion if unifyNameOnServer == true and will be unified on the server if it is necessary.
Attention: This functionality is license dependent. To use this method your FIRSTspirit license needs feature 'DOCUMENTGROUP'

Parameters:

uid - of the new document group

unifyNameOnServer - if true the given uid will be unified on server if necessary, otherwise a DuplicateReferenceNameException will be thrown, if an element with the given uid in the same namescope already exists on the server

Returns:

the new document group

Throws:

LockException - if this folder is locked in another session

DuplicateReferenceNameException - if unifyNameOnServer == false and an element with the given uid already exists on the server

LicenseException - if the installed FIRSTspirit license has no feature 'DOCUMENTGROUP'

ElementDeletedException

Since:

4.0.17

getFormData

@NotNull
SiteStoreVariableFormData getFormData()

Gets a form data container containing containig all defined sitestore variables. Inherited values are not included.

Specified by:

getFormData in interface DataProvider

Returns:

the formdata container of this element.

Since:

4.2.440

Example:

Example how to modify variables of SiteStoreFolder

getPageGroups

PageGroup[] getPageGroups()

Get the list of the page-groups for the current PageReference

Returns:

list of the page-groups objects

Since:

3.0

createPageGroup

PageGroup createPageGroup(String name)

Create a new page-group for the current PageReference. It's necessary to call StoreElement.save(String, boolean) on this folder afterwards

Parameters:

name - name of the new page-group

Returns:

new page-group as object

Since:

3.0

deletePageGroup

void deletePageGroup(PageGroup pageGroup)

Delete the given page-group for the current PageReference

Parameters:

pageGroup - page-group to be deleted

Since:

3.0

getStoredUrl

@Nullable
String getStoredUrl(@NotNull
                           Language language,
                           @NotNull
                           TemplateSet templateSet)

Get the stored URL for this node and the provided combination of language and template set.

Parameters:

language - Language to get the URL for.

templateSet - TemplateSet to get the URL for.

Returns:

The stored URL (absolute, without domain prefix) or null if no URL has been stored (yet).

Throws:

NullPointerException - if either parameter language or templateSet is null.

Since:

5.0.4

See Also:

URLProperties.getStoredUrl(SiteStoreFolder, Language, TemplateSet)