de.espirit.firstspirit.access.store.templatestore
Interface MasterTemplate

All Superinterfaces:

ChannelSourceProvider, Comparable<StoreElement>, GomSourceProvider, HistoryProvider, IDProvider, PackagePoolItem, PreviewImageProvider, Referenceable, StoreElement, Template, TemplateContentProvider, TemplateStoreElement, Workflowable

All Known Subinterfaces:

PageTemplate, SectionTemplate, TableTemplate

public interface MasterTemplate
extends Template

Mastertemplates are used to create nodes in pagestore (pages, sections, content sections)

Since:

4.1.28

Field Summary

static IDProvider.UidType

UID_TYPE

Fields inherited from interface de.espirit.firstspirit.access.store.templatestore.Template

CONTENT_TEMPLATE, LINK_TEMPLATE, PAGE_TEMPLATE, SECTION_TEMPLATE

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

BLOCKED, MODIFIED, UNMODIFIED

Method Summary

TemplateExtension[]	getExtensions() Get extension child nodes.
PageRef	getPreviewPageRef() Returns the pageref used to calculate previews of nodes without sitestore context (e.g.
TemplateExtension	getTemplateExtension(TemplateSet set)
long	getTemplateId() Get the project local ID of the Template
boolean	hasMultiPageParamsProviderEditor() Returns true if the form contains an editor which is an MultiPageParamsProvider.
void	setPreviewPageRef(PageRef pageRef) Sets the pageref used to calculate previews of nodes without sitestore context (e.g.

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

createAllowed, getAllowed, getAllowedTemplates, getBodies, getComment, getDescription, getFilename, getGuiXml, getGuiXmlNode, getPreviewSchedulerEntry, getTemplate, getTemplateSets, getType, getUniqueIdentifier, isHidden, setComment, setDescription, setFilename, setGuiXml, setHidden, setPreviewSchedulerEntry, setTemplate

Methods inherited from interface de.espirit.firstspirit.access.store.Referenceable

getReferenceName

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

clone, contrastWith, getDisplayName, getId, getID, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getReleaseRevision, getRevision, getUid, getUidType, hasMeta, hasUid, moveChild, moveChild, revert, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, exportStoreElement, getAllChilds, getAllFilteredChilds, getChildByName, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getChilds, getChilds, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getDisplayName, getEditor, getElementType, getFilteredChilds, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getLock, getMetaXml, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferences, getSortedChilds, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasMetaXml, 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, setMetaXml, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, unrelease, unrelease, update

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

getColor, getTask, hasTask, removeTask, setColor, setTask

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.templatestore.GomSourceProvider

getDefaults, getGomProvider, getGomSource, setDefaults, setGomProvider, setGomSource

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

clone, contrastWith, getDisplayName, getId, getID, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getReleaseRevision, getRevision, getUid, getUidType, hasMeta, hasUid, moveChild, moveChild, revert, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, exportStoreElement, getAllChilds, getAllFilteredChilds, getChildByName, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getChilds, getChilds, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getDisplayName, getEditor, getElementType, getFilteredChilds, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getLock, getMetaXml, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferences, getSortedChilds, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasMetaXml, 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, setMetaXml, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, unrelease, unrelease, update

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

getColor, getTask, hasTask, removeTask, setColor, setTask

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.templatestore.TemplateContentProvider

getTemplateDocument

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

getChannelSource, setChannelSource

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

clone, contrastWith, getDisplayName, getId, getID, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getReleaseRevision, getRevision, getUid, getUidType, hasMeta, hasUid, moveChild, moveChild, revert, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, exportStoreElement, getAllChilds, getAllFilteredChilds, getChildByName, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getChilds, getChilds, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getDisplayName, getEditor, getElementType, getFilteredChilds, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getLock, getMetaXml, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferences, getSortedChilds, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasMetaXml, 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, setMetaXml, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, unrelease, unrelease, update

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

getColor, getTask, hasTask, removeTask, setColor, setTask

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.PackagePoolItem

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

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

getSubRootInStore

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

getPreviewImage, setPreviewImage

Field Detail

UID_TYPE

static final IDProvider.UidType UID_TYPE

Since:

4.2.9

Method Detail

getTemplateId

long getTemplateId()

Get the project local ID of the Template

Specified by:

getTemplateId in interface Template

Returns:

project local ID of the Template

Since:

3.0

getPreviewPageRef

@Nullable
PageRef getPreviewPageRef()

Returns the pageref used to calculate previews of nodes without sitestore context (e.g. pages or content nodes)

Specified by:

getPreviewPageRef in interface Template

Returns:

the preview page ref or null

Since:

3.0

See Also:

MasterTemplate.setPreviewPageRef(de.espirit.firstspirit.access.store.sitestore.PageRef)

setPreviewPageRef

void setPreviewPageRef(@Nullable
                       PageRef pageRef)

Sets the pageref used to calculate previews of nodes without sitestore context (e.g. pages or content nodes)

Specified by:

setPreviewPageRef in interface Template

Parameters:

pageRef - the pageref which should be used for previews or null to remove the defined pageref

Since:

3.0

getTemplateExtension

TemplateExtension getTemplateExtension(TemplateSet set)

Specified by:

getTemplateExtension in interface Template

Since:

4.0

getExtensions

TemplateExtension[] getExtensions()

Get extension child nodes. The preferred way to obtain these information is to use MasterTemplate.getTemplateExtension(de.espirit.firstspirit.access.project.TemplateSet).

Specified by:

getExtensions in interface Template

Returns:

Array containing the extension nodes.

Since:

3.0

hasMultiPageParamsProviderEditor

boolean hasMultiPageParamsProviderEditor()

Returns true if the form contains an editor which is an MultiPageParamsProvider.

Since:

4.2.20