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

Interface FormatTemplates

All Superinterfaces:

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

public interface FormatTemplates
extends FormatTemplateContainer, RootFolder

This interface represants the subroot for format templates in templatestore.

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
FormatTemplate	createFormatTemplate(String name)	Create a new FormatTemplate
FormatTemplateFolder	createFormatTemplateFolder(String name)	Create a new format template folder with the given name.
FormatTemplate	getFormatTemplate(String uid)	Search a FormatTemplate by given uid

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.FormatTemplateContainer

createFormatTemplate, createFormatTemplateFolder, createStyleTemplate, createTableFormatTemplate, getStyleTemplate, getTableFormatTemplate

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 name)
                             throws LockException,
ElementDeletedException

Create a new FormatTemplate

Parameters:

name - name of the new FormatTemplate

Returns:

FormatTemplate as an object

Throws:

LockException

ElementDeletedException

Since:

3.0

getFormatTemplate

FormatTemplate getFormatTemplate(String uid)

Search a FormatTemplate by given uid

Specified by:

getFormatTemplate in interface FormatTemplateContainer

Parameters:

uid - the uid of the format-template to be found

Returns:

found FormatTemplate as an object

Since:

3.0

createFormatTemplateFolder

FormatTemplateFolder createFormatTemplateFolder(String name)
                                         throws LockException,
ElementDeletedException

Create a new format template folder with the given name.

Throws:

LockException

ElementDeletedException

Since:

3.0