public interface FormatTemplateContainer extends IDProvider, StoreElementFolder
TemplateStore
,
a container for FormatTemplates
FormatTemplates
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Modifier and Type | Method and 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,
Map<Language,String> lang2DisplayName)
Factory for a
StyleTemplate based on a uid. |
TableFormatTemplate |
createTableFormatTemplate(String uid,
boolean unifyNameOnServer,
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.
|
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
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, 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
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
FormatTemplate createFormatTemplate(String uid, Map<Language,String> lang2DisplayName, boolean unifyUid) throws LockException, DuplicateReferenceNameException, ElementDeletedException
uid
- the uid of the new FormatTemplatelang2DisplayName
- mapping of language
to language specific displayname; used to create LanguageInfo
nodesunifyUid
- if false
a DuplicateReferenceNameException
may be thrown , if
true
the name will be unified on the server if necessaryLockException
- if this format template container is locked in another sessionDuplicateReferenceNameException
- if unifyNameOnServer is false
and an element with the given uid in the same namescope already exits on the serverElementDeletedException
- if this folder is already deleted on the serverFormatTemplateFolder createFormatTemplateFolder(String name, Map<Language,String> lang2DisplayName) throws LockException, ElementDeletedException
FormatTemplateFolder
with the given name as child of this FormatTemplateContainer.name
- the name of the new FormatTemplateFolderlang2DisplayName
- mapping of language
to language specific displayname; used to create LanguageInfo
nodesLockException
- if this format template container is locked in another sessionElementDeletedException
- if this folder is already deleted on the serverFormatTemplate getFormatTemplate(String uid)
null
if no format template was found
with given uid or the format template is no child of this format template containeruid
- uid of the format-template to be foundnull
TableFormatTemplate createTableFormatTemplate(String uid, boolean unifyNameOnServer, @Nullable Map<Language,String> lang2DisplayName) throws LockException, DuplicateReferenceNameException, ElementDeletedException
TableFormatTemplate
based on a uid. If requested, the uid will be unified.uid
- The template's uid.unifyNameOnServer
- If true, the uid will be unified.lang2DisplayName
- A map of language dependent display names for the template.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.TableFormatTemplate getTableFormatTemplate(String uid)
uid
- The The template's uid.null
.StyleTemplate createStyleTemplate(String uid, boolean unifyNameOnServer, @Nullable Map<Language,String> lang2DisplayName) throws LockException, DuplicateReferenceNameException, ElementDeletedException
StyleTemplate
based on a uid. If requested, the uid will be unified.uid
- The template's uid.unifyNameOnServer
- If true, the uid will be unified.lang2DisplayName
- A map of language dependent display names for the template.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.StyleTemplate getStyleTemplate(long id)
id
- The template id.null
.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210