de.espirit.firstspirit.access.store.templatestore

Interface Script

All Superinterfaces:

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

public interface Script
extends Referenceable, GomSourceProvider, ChannelSourceProvider, PackagePoolItem, TemplateStoreElement, RulesetContainer

This interface provides methods to handle the scripts in the TemplateStore

Since:

3.0

See Also:

Scripts

Nested Class Summary

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.storage.HistoryProvider

HistoryProvider.RevisionProvider

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTEXT_MENUE
static int	MENUE
static int	MENUE_AND_HOMEPAGE Type used for scripts which can be used on javaclient extras menue and javaclient homepage
static int	TEMPLATE
static IDProvider.UidType	UID_TYPE
static int	UNINTERPRETED Deprecated. since 5.0.39 - use FormatTemplate instead

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

BLOCKED, MODIFIED, UNMODIFIED

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

CHANGED, NEVER_RELEASED, RELEASED

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAlwaysActive() Deprecated. since 4.2.474 - use isAlwaysActive()
String	getComment()
String	getDescription()
Executable	getExecutable(TemplateSet templateSet)
String	getName()
int	getType() Returns the type of this script.
IDProvider.UidType	getUidType() Returns the value of UID_TYPE.
String	getViewScript() Returns the view script defined for this script or an empty string.
Executable	getViewScriptExecutable() Delivers an executable of the related view script.
boolean	isAlwaysActive() Indicates whether this script is always active or not.
void	setAlwaysActive(boolean alwaysActive) Sets the always active flag for this script.
void	setComment(String comment)
void	setDescription(String description)
void	setName(String name)
void	setType(int type) Sets the type of the script.
void	setViewScript(String script) Defines the view script of this script.

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

getReferenceName

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.access.store.templatestore.ChannelSourceProvider

getChannelSource, setChannelSource

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

contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setMeta, setMetaFormData, setUid

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, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, 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, 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.RulesetContainer

getRulesetDefinition, setRulesetDefinition

Field Detail

TEMPLATE

static final int TEMPLATE

Since:

2.3.10

See Also:

Constant Field Values

MENUE

static final int MENUE

Since:

2.3.10

See Also:

Constant Field Values

CONTEXT_MENUE

static final int CONTEXT_MENUE

Since:

2.3.10

See Also:

Constant Field Values

UNINTERPRETED

@Deprecated
static final int UNINTERPRETED

Deprecated. since 5.0.39 - use FormatTemplate instead

Since:

2.3.11

See Also:

Constant Field Values

MENUE_AND_HOMEPAGE

static final int MENUE_AND_HOMEPAGE

Type used for scripts which can be used on javaclient extras menue and javaclient homepage

Since:

4.1.21

See Also:

Constant Field Values

UID_TYPE

static final IDProvider.UidType UID_TYPE

Since:

4.0.18

Method Detail

getName

@NotNull
String getName()

Specified by:

getName in interface StoreElement

Since:

3.0

setName

void setName(String name)

Since:

3.0

getDescription

String getDescription()

Since:

3.0

setDescription

void setDescription(String description)

Since:

3.0

getComment

String getComment()

Since:

3.0

setComment

void setComment(String comment)

Since:

3.0

getType

int getType()

Returns the type of this script. One of TEMPLATE, MENUE, CONTEXT_MENUE, UNINTERPRETED

Returns:

type of the script. One of TEMPLATE, MENUE, CONTEXT_MENUE, UNINTERPRETED

Since:

3.0

setType

void setType(int type)

Sets the type of the script. One of TEMPLATE, MENUE, CONTEXT_MENUE, UNINTERPRETED

Parameters:

type - One of TEMPLATE, MENUE, CONTEXT_MENUE, UNINTERPRETED

Since:

3.0

getAlwaysActive

@Deprecated
boolean getAlwaysActive()

Deprecated. since 4.2.474 - use isAlwaysActive()

Since:

3.0

isAlwaysActive

boolean isAlwaysActive()

Indicates whether this script is always active or not. If this method delivers false the related view script will be executed to evaluate the visibility state of the script.

Returns:

true if this script is always active, false otherwise

Since:

4.2.474

See Also:

setAlwaysActive(boolean), getViewScriptExecutable(), getViewScript()

setAlwaysActive

void setAlwaysActive(boolean alwaysActive)

Sets the always active flag for this script. If always active is set to false the related view script will be executed to evaluate the visibility state.

Since:

3.0

See Also:

getViewScript(), isAlwaysActive(), getViewScriptExecutable(), setViewScript(String)

getViewScript

@NotNull
String getViewScript()

Returns the view script defined for this script or an empty string.

Since:

3.0

See Also:

getViewScriptExecutable()

getViewScriptExecutable

Executable getViewScriptExecutable()

Delivers an executable of the related view script. This view script will be executed if this script is not defined as always active to evaluate the visibility state of this script. The script should return a boolean value to define visibility. Since 5.0 the usage of setProperty with property visible in the context is deprecated.

Since:

4.0.120

See Also:

setViewScript(String)

setViewScript

void setViewScript(String script)

Defines the view script of this script. The given script will be executed if this script is not defined as always active to evaluate the visibility state of this script. The given script should return a boolean value to define visibility. Since 5.0 the usage of setProperty with property visible in the context is deprecated.

Since:

3.0

See Also:

getViewScript(), getViewScriptExecutable()

getExecutable

Executable getExecutable(TemplateSet templateSet)

Since:

4.0.120

getUidType

@NotNull
IDProvider.UidType getUidType()

Returns the value of UID_TYPE.

Specified by:

getUidType in interface IDProvider

Returns:

the unique identifier

Since:

4.0

See Also:

IDProvider.hasUid()