Package de.espirit.firstspirit.access.store.templatestore

Interface TemplateContainer<T extends Template>

All Superinterfaces:

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

All Known Subinterfaces:

LinkTemplates, PageTemplates, SectionTemplates, TemplateFolder<T>

public interface TemplateContainer<T extends Template>
extends IDProvider, StoreElementFolder

Interface providing methods for elements which can have templates as children.

Since:

4.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
T	createTemplate(@NotNull String uid)	Create a new template in this folder.
T	createTemplate(@NotNull String uid, boolean unifyNamesOnServer)	Create a new template in this folder.
T	createTemplate(@NotNull String uid, @Nullable Map<Language,String> lang2DisplayName, boolean unifyNamesOnServer)	Create a new template in this folder.
TemplateFolder<T>	createTemplateFolder(@NotNull String name)	Create a new sub-folder in this folder
TemplateFolder<T>	createTemplateFolder(@NotNull String name, @Nullable Map<Language,String> lang2DisplayName)	Create a new sub-folder in this folder
T	getTemplate(@NotNull String uid)	Returns page template with the given uid or null.
Class<T>	getTemplateType()	Generic type information of the template type this template container may hold.

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, isReachableInReleaseStore, 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, getName, 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

getTemplateType

Class<T> getTemplateType()

Generic type information of the template type this template container may hold.

Returns:

the template type this template container may hold

Since:

4.1.24

createTemplateFolder

TemplateFolder<T> createTemplateFolder(@NotNull
 @NotNull String name)
                                throws LockException,
ElementDeletedException

Create a new sub-folder in this folder

Parameters:

name - name of the new folder

Returns:

the new created folder

Throws:

LockException

ElementDeletedException

Since:

3.0

createTemplateFolder

TemplateFolder<T> createTemplateFolder(@NotNull
 @NotNull String name,
 @Nullable
 @Nullable Map<Language,String> lang2DisplayName)
                                throws LockException,
ElementDeletedException

Create a new sub-folder in this folder

Parameters:

name - name of the new folder

Returns:

the new created folder

Throws:

LockException

ElementDeletedException

Since:

3.0

createTemplate

T createTemplate(@NotNull
 @NotNull String uid)
          throws LockException,
DuplicateReferenceNameException,
ElementDeletedException

Create a new template in this folder.

Parameters:

uid - the uid of the new template

Returns:

the new crated template

Throws:

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

LockException - if this template container is locked in another session

ElementDeletedException

Since:

3.1.158

createTemplate

T createTemplate(@NotNull
 @NotNull String uid,
 boolean unifyNamesOnServer)
          throws LockException,
DuplicateReferenceNameException,
ElementDeletedException

Create a new template in this folder. The given uid is used as suggestion if unifyNameOnServer == true and will be unified on the server if it is necessary.

Parameters:

uid - the uid of the new template

unifyNamesOnServer - if true the given uid will be unified on server if necessary, otherwise a DuplicateReferenceNameException will be thrown, if a template with the given uid already exist

Returns:

the new created template

Throws:

DuplicateReferenceNameException - if a template with the given uid already exists on the server and unifyNamesOnServer == false

LockException - if this template container is locked in another session

ElementDeletedException

Since:

4.0

createTemplate

T createTemplate(@NotNull
 @NotNull String uid,
 @Nullable
 @Nullable Map<Language,String> lang2DisplayName,
 boolean unifyNamesOnServer)
          throws LockException,
DuplicateReferenceNameException,
ElementDeletedException

Create a new template in this folder. The given uid is used as suggestion if unifyNameOnServer == true and will be unified on the server if it is necessary.

Parameters:

uid - the uid of the new template

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

unifyNamesOnServer - if true the given uid will be unified on server if necessary, otherwise a DuplicateReferenceNameException will be thrown, if a template with the given uid already exist

Returns:

the new created template

Throws:

DuplicateReferenceNameException - if a template with the given uid already exists on the server and unifyNamesOnServer == false

LockException - if this template container is locked in another session

ElementDeletedException

Since:

4.0.120

getTemplate

@Nullable
T getTemplate(@NotNull
 @NotNull String uid)

Returns page template with the given uid or null.

Parameters:

uid - unique identifier without type prefix.

Returns:

page template with the given uid or null.

Since:

4.0

See Also:

• Store.getStoreElement(String, de.espirit.firstspirit.access.store.IDProvider.UidType)