Interface TemplateStoreRoot
- All Superinterfaces:
Comparable<StoreElement>
,HistoryProvider
,IDProvider
,Store
,StoreElement
,StoreElementFolder
,Workflowable
This interface provides methods for the TemplateStore root node, i.e. access to the sub root nodes, getting a
template by its 'template id' (
getTemplateById(long)
, and getting a workflow by its 'workflow id'
(getWorkflowById(long)
).- 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
Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.Store
Store.Type
-
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 TypeMethodDescriptionAccess to the sub root node for format templates.Access to the sub root node for link templates.Access to the sub root node for page templates.Access to the sub root node for schema nodes.Access to the sub root node for scripts.Access to the sub root node for section templates.@Nullable MasterTemplate
getTemplateById
(long templateId) Get the template by giventemplate id
ornull
if no template exists with the given template id.@Nullable Workflow
getWorkflowById
(long workflowId) Returns the workflow with the givenworkflow id
null
if no workflow exits with the given id.@Nullable Workflow
getWorkflowByName
(String name) Get a workflow by itsuid
.Access to the sub root node for workflows.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.Store
addStoreListener, getDeletedChildren, getDeletedChildren, getDeletedChilds, getDeletedChilds, getElements, getMaxRevision, getProject, getStoreElement, getStoreElement, getStoreElement, getStoreElement, getType, getUserService, isFolder, isReadOnly, isRelease, removeStoreListener, restore
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, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, 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
-
getTemplateById
Get the template by giventemplate id
ornull
if no template exists with the given template id. The template id id is not equal toIDProvider.getId()
.- Parameters:
templateId
- template id of the template to search .- Returns:
- The template with the given template id or
null
. - Since:
- 4.0
-
getPageTemplates
PageTemplates getPageTemplates()Access to the sub root node for page templates.- Since:
- 3.0
-
getSectionTemplates
SectionTemplates getSectionTemplates()Access to the sub root node for section templates.- Since:
- 3.0
-
getFormatTemplates
FormatTemplates getFormatTemplates()Access to the sub root node for format templates.- Since:
- 3.0
-
getScripts
Scripts getScripts()Access to the sub root node for scripts.- Since:
- 3.0
-
getLinkTemplates
LinkTemplates getLinkTemplates()Access to the sub root node for link templates.- Since:
- 3.0
-
getWorkflows
Workflows getWorkflows()Access to the sub root node for workflows.- Since:
- 3.0
-
getWorkflowById
Returns the workflow with the givenworkflow id
null
if no workflow exits with the given id.- Since:
- 3.0
-
getWorkflowByName
Get a workflow by itsuid
.- Since:
- 3.0
- See Also:
-
getSchemes
Schemes getSchemes()Access to the sub root node for schema nodes.- Since:
- 3.0
-