Package de.espirit.firstspirit.access.store.globalstore

Interface GCAFolder

All Superinterfaces:

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

All Known Subinterfaces:

GlobalContentArea

public interface GCAFolder
extends IDProvider, StoreElementFolder

This interface represents folders in globalstore

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 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
GCAFolder	createGCAFolder(String uidSuggestion)	Create a new GCA-folder as a subfolder of this folder.
GCAFolder	createGCAFolder(String uidSuggestion, boolean unifyUid)	Create a new GCA-folder as a subfolder of this folder.
GCAFolder	createGCAFolder(String uid, Map<Language,String> lang2DisplayName, boolean unifyUid)	Create a new GCAFolder as a subfolder of this folder.
GCAPage	createGCAPage(String uidSuggestion, Template pageTemplate)	Create a new Page in the current GCA-folder based on the given PageTemplate
GCAPage	createGCAPage(String uidSuggestion, Template pageTemplate, boolean unifyUid)	Create a new Page in the current GCA-Folder based on the given PageTemplate
GCAPage	createGCAPage(String uidSuggestion, Template pageTemplate, boolean unifyUid, Map<Language,String> lang2DisplayName)	Create a new Page in the current GCA-Folder based on the given PageTemplate
@NotNull String	getName()	Get the name of the GCA-folder
void	setName(String name)	Set the name of the GCA-folder

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, getReleaseRevision, getReleaseStatus, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isInReleaseStore, isReleased, isReleased, isReleaseSupported, moveChild, moveChild, release, release, 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, 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

Method Details

createGCAFolder

GCAFolder createGCAFolder(String uidSuggestion)
                   throws LockException,
ElementDeletedException

Create a new GCA-folder as a subfolder of this folder. The given uidSuggestion will be unified on the server if necessary. Calls createGCAFolder(uidSuggestion, true)

Parameters:

uidSuggestion - the suggestion for the uid of the created folder

Returns:

the created GCAFolder

Throws:

LockException - if this GCAFolder is locked in a different session on the server

ElementDeletedException

Since:

3.0

See Also:

• createGCAPage(String, de.espirit.firstspirit.access.store.templatestore.Template, boolean)

createGCAFolder

GCAFolder createGCAFolder(String uidSuggestion,
 boolean unifyUid)
                   throws LockException,
DuplicateReferenceNameException,
ElementDeletedException

Create a new GCA-folder as a subfolder of this folder.

Parameters:

uidSuggestion - the suggestion for the uid of the created folder

unifyUid - use true if the given uidSuggestion should be unified on the server, false otherwise

Returns:

the created GCAFolder

Throws:

LockException - if this GCAFolder is locked in a different session on the server

DuplicateReferenceNameException - if unifyUid==false and the given uidSuggestion is not unique on the server

ElementDeletedException

Since:

4.0

createGCAFolder

GCAFolder createGCAFolder(String uid,
 Map<Language,String> lang2DisplayName,
 boolean unifyUid)
                   throws ElementDeletedException,
LockException,
DuplicateReferenceNameException

Create a new GCAFolder as a subfolder of this folder.

Parameters:

uid - uid of the new PageFolder

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

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

Returns:

GCAFolder 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

Since:

4.0.90

createGCAPage

GCAPage createGCAPage(String uidSuggestion,
 Template pageTemplate)
               throws IOException,
LockException,
DuplicateReferenceNameException,
ElementDeletedException

Create a new Page in the current GCA-folder based on the given PageTemplate

Parameters:

uidSuggestion - the suggestion for the uid of the created page

pageTemplate - PageTemplate on which the new GCAPage will be based

Returns:

the created GCAPage

Throws:

LockException - if this GCAFolder is locked in a different session on the server

DuplicateReferenceNameException - if the given uidSuggestion is not unique on the server

IOException

ElementDeletedException

Since:

3.0

createGCAPage

GCAPage createGCAPage(String uidSuggestion,
 Template pageTemplate,
 boolean unifyUid)
               throws LockException,
DuplicateReferenceNameException,
ElementDeletedException

Create a new Page in the current GCA-Folder based on the given PageTemplate

Parameters:

uidSuggestion - the suggestion for the uid of the created page

pageTemplate - PageTemplate on which the new GCAPage will be based

unifyUid - use true if the given uidSuggestion should be unified on the server, false otherwise

Returns:

the created GCAPage

Throws:

LockException - if this GCAFolder is locked in a different session on the server

DuplicateReferenceNameException - if unifyUid==false and the given uidSuggestion is not unique on the server

ElementDeletedException

Since:

4.0

createGCAPage

GCAPage createGCAPage(String uidSuggestion,
 Template pageTemplate,
 boolean unifyUid,
 Map<Language,String> lang2DisplayName)
               throws LockException,
DuplicateReferenceNameException,
ElementDeletedException

Create a new Page in the current GCA-Folder based on the given PageTemplate

Parameters:

uidSuggestion - the suggestion for the uid of the created page

pageTemplate - PageTemplate on which the new GCAPage will be based

unifyUid - use true if the given uidSuggestion should be unified on the server, false otherwise

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

Returns:

the created GCAPage

Throws:

LockException - if this GCAFolder is locked in a different session on the server

DuplicateReferenceNameException - if unifyUid==false and the given uidSuggestion is not unique on the server

ElementDeletedException

Since:

4.1.10

getName

@NotNull
@NotNull String getName()

Get the name of the GCA-folder

Specified by:

getName in interface StoreElement

Returns:

name of the GCA-folder

Since:

3.0

setName

void setName(String name)
      throws LockException

Set the name of the GCA-folder

Parameters:

name - name of the GCA-folder

Throws:

LockException

Since:

3.0