public interface Script extends Referenceable, GomSourceProvider, ChannelSourceProvider, PackagePoolItem, TemplateStoreElement, RulesetContainer
TemplateStore
Scripts
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static int |
CONTEXT_MENUE
Applicable for context menu use.
|
static int |
MENUE
Applicable for menu use.
|
static int |
MENUE_AND_HOMEPAGE
Type used for scripts which can be used on javaclient extras menue and javaclient homepage
|
static int |
TEMPLATE
Applicable for template use.
|
static IDProvider.UidType |
UID_TYPE
The script UID type.
|
static int |
UNINTERPRETED
Deprecated.
since 5.0.39 - use
FormatTemplate instead |
BLOCKED, MODIFIED, UNMODIFIED
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
Modifier and Type | Method and Description |
---|---|
String |
getComment()
Provides the comment set for this script.
|
String |
getDescription()
Provides a description of this script.
|
Executable |
getExecutable(TemplateSet templateSet)
Provides an executable based on the requested template set.
|
String |
getName()
Provides the name of the script.
|
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)
Defines the comment for this script.
|
void |
setDescription(String description)
Defines the description of this script.
|
void |
setName(String name)
Defines the name of the script.
|
void |
setType(int type)
Sets the type of the script.
|
void |
setViewScript(String script)
Defines the view script of this script.
|
getReferenceName
getDefaults, getFormDefaults, getGomProvider, getGomSource, setDefaults, setFormDefaults, setGomProvider, setGomSource
getChannelSource, setChannelSource
addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState
getSubRootInStore
contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, 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, 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
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
getRulesetDefinition, setRulesetDefinition
static final int TEMPLATE
static final int MENUE
static final int CONTEXT_MENUE
@Deprecated static final int UNINTERPRETED
FormatTemplate
insteadstatic final int MENUE_AND_HOMEPAGE
static final IDProvider.UidType UID_TYPE
@NotNull String getName()
getName
in interface StoreElement
void setName(String name)
name
- The script's name.String getDescription()
void setDescription(String description)
description
- The script's description.String getComment()
void setComment(String comment)
comment
- The comment.int getType()
TEMPLATE
, MENUE
, CONTEXT_MENUE
, UNINTERPRETED
void setType(int type)
type
- One of TEMPLATE
, MENUE
, CONTEXT_MENUE
, UNINTERPRETED
boolean isAlwaysActive()
false
the related view script
will be executed
to evaluate the visibility state of the script.true
if this script is always active, false
otherwisesetAlwaysActive(boolean)
,
getViewScriptExecutable()
,
getViewScript()
void setAlwaysActive(boolean alwaysActive)
false
the related
view script
will be executed to evaluate the visibility state.getViewScript()
,
isAlwaysActive()
,
getViewScriptExecutable()
,
setViewScript(String)
@NotNull String getViewScript()
getViewScriptExecutable()
Executable getViewScriptExecutable()
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.setViewScript(String)
void setViewScript(String script)
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.getViewScript()
,
getViewScriptExecutable()
Executable getExecutable(TemplateSet templateSet)
null
.@NotNull IDProvider.UidType getUidType()
UID_TYPE
.getUidType
in interface IDProvider
IDProvider.hasUid()
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210