Package de.espirit.firstspirit.access.store.contentstore

Interface ContentFolder

All Superinterfaces:

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

All Known Subinterfaces:

ContentStoreRoot

public interface ContentFolder
extends IDProvider, StoreElementFolder

This interface provides methods to handle the ContentStore-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 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
Content2	addContent(TableTemplate table, String name)	Creates and returns a content2 node based on the given template.
Content2	createContent(TableTemplate tableTemplate, String uidSuggestion, @Nullable Map<Language,String> language2displayNameMapping, boolean unifyUidOnServer)	Creates a new content node in this folder.
ContentFolder	createContentFolder(String uidSuggestion)	Calls createContentFolder(uidSuggestion, true).
ContentFolder	createContentFolder(String uidSuggestion, boolean unifyUid)	Create a new ContentFolder as child of this folder.
ContentFolder	createContentFolder(String uidSuggestion, @Nullable Map<Language,String> lang2DisplayName, boolean unifyUid)	Create a new ContentFolder as child of this folder.
@NotNull String	getName()	Get the name of the ContentStore-folder
void	setName(String name)	Set the name of the ContentStore-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, 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

Method Details

getName

@NotNull
@NotNull String getName()

Get the name of the ContentStore-folder

Specified by:

getName in interface StoreElement

Returns:

name of the ContentStore-folder

Since:

3.0

setName

void setName(String name)

Set the name of the ContentStore-folder

Parameters:

name - name of the ContentStore-folder

Since:

3.0

addContent

Content2 addContent(TableTemplate table,
 String name)
             throws LockException,
ElementDeletedException

Creates and returns a content2 node based on the given template.

Parameters:

table - The table template.

name - The uid suggestion.

Returns:

The created content2 element.

Throws:

LockException - If this content folder is locked in another session.

ElementDeletedException

Since:

3.0

See Also:

• createContent(TableTemplate, String, Map, boolean)

createContent

Content2 createContent(TableTemplate tableTemplate,
 String uidSuggestion,
 @Nullable
 @Nullable Map<Language,String> language2displayNameMapping,
 boolean unifyUidOnServer)
                throws LockException,
ElementDeletedException,
DuplicateReferenceNameException

Creates a new content node 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:

uidSuggestion - of the new content node

tableTemplate - the tabletemplate the new content node will be based on

unifyUidOnServer - 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

language2displayNameMapping - mapping of language to language specific displayname; used to create LanguageInfo nodes, optional -> can be null

Returns:

the new created content2 instance

Throws:

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

LockException - if this content folder is locked in another session

ElementDeletedException

Since:

4.0.39

createContentFolder

ContentFolder createContentFolder(String uidSuggestion)
                           throws LockException,
ElementDeletedException

Calls createContentFolder(uidSuggestion, true).

Throws:

LockException

ElementDeletedException

Since:

4.1.11

createContentFolder

ContentFolder createContentFolder(String uidSuggestion,
 boolean unifyUid)
                           throws LockException,
ElementDeletedException

Create a new ContentFolder as child of this folder.

Parameters:

uidSuggestion - uidSuggestion of the new ContentFolder

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

Returns:

the new created ContentFolder

Throws:

LockException - if this folder is locked in another session

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

ElementDeletedException

Since:

4.1.11

createContentFolder

ContentFolder createContentFolder(String uidSuggestion,
 @Nullable
 @Nullable Map<Language,String> lang2DisplayName,
 boolean unifyUid)
                           throws LockException,
ElementDeletedException

Create a new ContentFolder as child of this folder.

Parameters:

uidSuggestion - uidSuggestion of the new ContentFolder

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

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

Returns:

the new created ContentFolder

Throws:

LockException - if this folder is locked in another session

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

ElementDeletedException

Since:

4.0.14