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

Interface Template

All Superinterfaces:

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

All Known Subinterfaces:

LinkTemplate, MasterTemplate, PageTemplate, SectionTemplate, TableTemplate

public interface Template
extends Referenceable, GomSourceProvider, TemplateContentProvider, RulesetContainer, SnippetContainer, PackagePoolItem, TemplateStoreElement, PreviewImageProvider, StoreElement

This interface provides methods to handle templates.

Since:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CONTENT_TEMPLATE	Type of the template: Content store template.
static final int	LINK_TEMPLATE	Type of the template: Link template.
static final int	PAGE_TEMPLATE	Type of the template: Page template.
static final int	SECTION_TEMPLATE	Type of the template: Section template.

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
@Nullable String	getComment()	Get the comment of the Template
int	getType()	Get the type of the Template.
boolean	isHidden()	State if the template is hidden in the selection-list.
void	setComment(String comment)	Set the comment of the Template
void	setHidden(boolean hidden)	Set if the template should be hidden.

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

PAGE_TEMPLATE

static final int PAGE_TEMPLATE

Type of the template: Page template.

Since:

3.0

See Also:

• Constant Field Values

SECTION_TEMPLATE

static final int SECTION_TEMPLATE

Type of the template: Section template.

Since:

3.0

See Also:

• Constant Field Values

CONTENT_TEMPLATE

static final int CONTENT_TEMPLATE

Type of the template: Content store template.

Since:

3.0

See Also:

• Constant Field Values

LINK_TEMPLATE

static final int LINK_TEMPLATE

Type of the template: Link template.

Since:

4.1.24

See Also:

• Constant Field Values

Method Details

getType

int getType()

Get the type of the Template.

Returns:

one of the following

• PAGE_TEMPLATE
• SECTION_TEMPLATE
• CONTENT_TEMPLATE
• LINK_TEMPLATE

Since:

3.0

getComment

@Nullable
@Nullable String getComment()

Get the comment of the Template

Returns:

comment of the Template

Since:

3.0

setComment

void setComment(String comment)

Set the comment of the Template

Parameters:

comment - new comment of the Template or null to remove the existing comment

Since:

3.0

isHidden

boolean isHidden()

State if the template is hidden in the selection-list.

Since:

3.0

setHidden

void setHidden(boolean hidden)

Set if the template should be hidden.

Since:

3.0