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

Interface MasterTemplate

All Superinterfaces:

ChannelSourceProvider, Comparable<StoreElement>, GomSourceProvider, HistoryProvider, IDProvider, PackagePoolItem, PreviewImageProvider, Referenceable, RulesetContainer, RulesetContainer, SnippetContainer, 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

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

Modifier and Type	Field	Description
static final IDProvider.UidType	UID_TYPE	Uid type as returned by IDProvider.getUidType().

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

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

CONTENT_TEMPLATE, LINK_TEMPLATE, PAGE_TEMPLATE, SECTION_TEMPLATE

Method Summary

Modifier and Type	Method	Description
TemplateExtension[]	getExtensions()	Deprecated. since 5.0.101 Use getTemplateExtension(de.espirit.firstspirit.access.project.TemplateSet).
@Nullable PageRef	getPreviewPageRef()	Returns the pageref used to calculate previews of nodes without sitestore context (e.g.
@NotNull TemplateExtension	getTemplateExtension(TemplateSet set)	Returns the template extension object for the given template set.
long	getTemplateId()	Get the project local ID of the Template
boolean	hasMultiPageParamsProviderEditor()	Deprecated. Since 5.0.104, no replacement.
boolean	hasPreviewPageRef()	Indicates that a preview page ref is set for this template.
void	setPreviewPageRef(@Nullable 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.ChannelSourceProvider

getChannelSource, setChannelSource

Methods inherited from interface java.lang.Comparable

compareTo

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

getDefaults, getFormDefaults, getGomProvider, getGomSource, setDefaults, setFormDefaults, setGomProvider, setGomSource

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

getPreviewImage, setPreviewImage

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

getReferenceName

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

getRulesetDefinition, setRulesetDefinition

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

getSnippet, setSnippet

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, 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.Template

getComment, getType, isHidden, setComment, setHidden

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

getTemplateDocument

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

Field Details

UID_TYPE

static final IDProvider.UidType UID_TYPE

Uid type as returned by IDProvider.getUidType().

Since:

4.2.9

Method Details

getTemplateId

long getTemplateId()

Get the project local ID of the Template

Returns:

project local ID of the Template

Since:

3.0

hasPreviewPageRef

boolean hasPreviewPageRef()

Indicates that a preview page ref is set for this template.

Returns:

true, if a preview page is defined.

Since:

5.1.34

getPreviewPageRef

@Nullable
@Nullable PageRef getPreviewPageRef()

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

Returns:

the preview page ref or null

Since:

3.0

See Also:

• setPreviewPageRef(de.espirit.firstspirit.access.store.sitestore.PageRef)
• hasPreviewPageRef()

setPreviewPageRef

void setPreviewPageRef(@Nullable
 @Nullable PageRef pageRef)

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

Parameters:

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

Since:

3.0

getTemplateExtension

@NotNull
@NotNull TemplateExtension getTemplateExtension(TemplateSet set)

Returns the template extension object for the given template set.

Returns:

The template extension object for the given template set.

Since:

4.0

getExtensions

@Deprecated
TemplateExtension[] getExtensions()

Deprecated.

since 5.0.101 Use getTemplateExtension(de.espirit.firstspirit.access.project.TemplateSet).

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

Returns:

Array containing the extension nodes.

Since:

3.0

hasMultiPageParamsProviderEditor

@Deprecated
boolean hasMultiPageParamsProviderEditor()

Deprecated.

Since 5.0.104, no replacement.

Returns always false. Methods remains for backward compatibilty and will be removed in a future version.

Since:

4.2.20