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

Interface FormatTemplateFolder

All Superinterfaces:

Comparable<StoreElement>, FormatTemplateContainer, HistoryProvider, IDProvider, PackagePoolItem, StoreElement, StoreElementFolder, TemplateStoreElement, Workflowable

public interface FormatTemplateFolder
extends FormatTemplateContainer, TemplateStoreElement, PackagePoolItem, StoreElement

This interface provides methods to handle FormatTemplateFolder in TemplateStore

Since:

2.3.14

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

Fields inherited from interface de.espirit.firstspirit.access.store.PackagePoolItem

BLOCKED, MODIFIED, UNMODIFIED

Method Summary

Modifier and Type	Method	Description
FormatTemplate	createFormatTemplate(String name)	Factory for a format template having the given name.
FormatTemplateFolder	createFormatTemplateFolder(String name)	Factory to create a subfolder with the given name.
void	setName(String name)	Defines the name for this folder.

Methods inherited from interface java.lang.Comparable

compareTo

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

createFormatTemplate, createFormatTemplateFolder, createStyleTemplate, createTableFormatTemplate, getFormatTemplate, 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.PackagePoolItem

addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState

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.store.templatestore.TemplateStoreElement

getSubRootInStore

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Method Details

setName

void setName(String name)

Defines the name for this folder.

Parameters:

name - The name.

Since:

2.3.14

createFormatTemplate

FormatTemplate createFormatTemplate(String name)
                             throws LockException,
ElementDeletedException

Factory for a format template having the given name.

Parameters:

name - the name.

Throws:

LockException - if a required lock could not be acquired.

ElementDeletedException - if this folder already is deleted.

Since:

2.3.14

createFormatTemplateFolder

FormatTemplateFolder createFormatTemplateFolder(String name)
                                         throws LockException,
ElementDeletedException

Factory to create a subfolder with the given name.

Parameters:

name - the name.

Throws:

LockException - if a required lock could not be acquired.

ElementDeletedException - if this folder already is deleted.

Since:

2.3.14