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

Interface FormatTemplateContainer

All Superinterfaces:

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

All Known Subinterfaces:

FormatTemplateFolder, FormatTemplates

public interface FormatTemplateContainer
extends IDProvider, StoreElementFolder

This interface provides methods to handle FormatTemplateContainer in TemplateStore, a container for FormatTemplates

Since:

4.0.29

See Also:

• FormatTemplates

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
FormatTemplate	createFormatTemplate(String uid, Map<Language,String> lang2DisplayName, boolean unifyUid)	Creates a new FormatTemplate as child of this FormatTemplateContainer
FormatTemplateFolder	createFormatTemplateFolder(String name, Map<Language,String> lang2DisplayName)	Creates a new FormatTemplateFolder with the given name as child of this FormatTemplateContainer.
StyleTemplate	createStyleTemplate(String uid, boolean unifyNameOnServer, @Nullable Map<Language,String> lang2DisplayName)	Factory for a StyleTemplate based on a uid.
TableFormatTemplate	createTableFormatTemplate(String uid, boolean unifyNameOnServer, @Nullable Map<Language,String> lang2DisplayName)	Factory for a TableFormatTemplate based on a uid.
FormatTemplate	getFormatTemplate(String uid)	Search a FormatTemplate by given uid.
StyleTemplate	getStyleTemplate(long id)	Looks up the template having the given id.
TableFormatTemplate	getTableFormatTemplate(String uid)	Looks up the template having the given uid.

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

createFormatTemplate

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

Creates a new FormatTemplate as child of this FormatTemplateContainer

Parameters:

uid - the uid of the new FormatTemplate

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 format template

Throws:

LockException - if this format template container 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.29

createFormatTemplateFolder

FormatTemplateFolder createFormatTemplateFolder(String name,
 Map<Language,String> lang2DisplayName)
                                         throws LockException,
ElementDeletedException

Creates a new FormatTemplateFolder with the given name as child of this FormatTemplateContainer.

Parameters:

name - the name of the new FormatTemplateFolder

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

Returns:

the new created folder

Throws:

LockException - if this format template container is locked in another session

ElementDeletedException - if this folder is already deleted on the server

Since:

4.2.400

getFormatTemplate

FormatTemplate getFormatTemplate(String uid)

Search a FormatTemplate by given uid. Returns null if no format template was found with given uid or the format template is no child of this format template container

Parameters:

uid - uid of the format-template to be found

Returns:

the format template specified by given uid or null

Since:

4.0.29

createTableFormatTemplate

TableFormatTemplate createTableFormatTemplate(String uid,
 boolean unifyNameOnServer,
 @Nullable
 @Nullable Map<Language,String> lang2DisplayName)
                                       throws LockException,
DuplicateReferenceNameException,
ElementDeletedException

Factory for a TableFormatTemplate based on a uid. If requested, the uid will be unified.

Parameters:

uid - The template's uid.

unifyNameOnServer - If true, the uid will be unified.

lang2DisplayName - A map of language dependent display names for the template.

Returns:

The resulting template.

Throws:

LockException - if a required lock could not be acquired.

DuplicateReferenceNameException - if the uid is already taken (and unification is off).

ElementDeletedException - if the parent container does no longer exist.

Since:

4.0.120

getTableFormatTemplate

TableFormatTemplate getTableFormatTemplate(String uid)

Looks up the template having the given uid.

Parameters:

uid - The The template's uid.

Returns:

The matching template or null.

Since:

4.0.120

createStyleTemplate

StyleTemplate createStyleTemplate(String uid,
 boolean unifyNameOnServer,
 @Nullable
 @Nullable Map<Language,String> lang2DisplayName)
                           throws LockException,
DuplicateReferenceNameException,
ElementDeletedException

Factory for a StyleTemplate based on a uid. If requested, the uid will be unified.

Parameters:

uid - The template's uid.

unifyNameOnServer - If true, the uid will be unified.

lang2DisplayName - A map of language dependent display names for the template.

Returns:

The resulting template.

Throws:

LockException - if a required lock could not be acquired.

DuplicateReferenceNameException - if the uid is already taken (and unification is off).

ElementDeletedException - if the parent container does no longer exist.

Since:

4.0.120

getStyleTemplate

StyleTemplate getStyleTemplate(long id)

Looks up the template having the given id.

Parameters:

id - The template id.

Returns:

The matching template or null.

Since:

4.0.120