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

Interface ScriptContainer

All Superinterfaces:

Comparable<StoreElement>, HistoryProvider, IDProvider, StoreElement, Workflowable

All Known Subinterfaces:

ScriptFolder, Scripts

public interface ScriptContainer
extends IDProvider

Interface providing methods for elements which can have scripts as children.

Since:

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

Method Summary

Modifier and Type	Method	Description
Script	createScript(String uid, @Nullable Map<Language,String> lang2DisplayName, boolean unifyUid)	Creates a new Script as child of this ScriptContainer
Script	createScript(String name, String description)	Calls createScript(String, java.util.Map, boolean) and uses the given description as displayname for the default editorial language.
ScriptFolder	createScriptFolder(String name)	Calls createScriptFolder(name, null)
ScriptFolder	createScriptFolder(String name, @Nullable Map<Language,String> lang2DisplayName)	Creates a ScriptFolder with the given name and displaynames as a child of this ScriptContainer.
List<Script>	getAllScripts()	Deprecated. since 5.0.100 - use getChildren(Script.class), true instead
Script	getScriptByName(String uid)	Returns the script specified by the given uid or null if no script with given uid exists as child of this script container

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

getColor, getTask, hasTask, removeTask, setColor, setTask

Method Details

createScriptFolder

ScriptFolder createScriptFolder(String name)
                         throws LockException,
ElementDeletedException

Calls createScriptFolder(name, null)

Throws:

LockException

ElementDeletedException

Since:

3.0

See Also:

• createScriptFolder(String, java.util.Map)

createScriptFolder

ScriptFolder createScriptFolder(String name,
 @Nullable
 @Nullable Map<Language,String> lang2DisplayName)
                         throws LockException,
ElementDeletedException

Creates a ScriptFolder with the given name and displaynames as a child of this ScriptContainer.

Parameters:

name - the name of the new folder

lang2DisplayName - mapping of language to language specific displayname; used to create LanguageInfo nodes

Returns:

the new folder

Throws:

LockException - if this folder is locked in another session

ElementDeletedException - if this folder is already deleted on the server

Since:

4.2.400

createScript

Script createScript(String name,
 String description)
             throws LockException,
ElementDeletedException

Calls createScript(String, java.util.Map, boolean) and uses the given description as displayname for the default editorial language.

Throws:

LockException

ElementDeletedException

Since:

3.0

See Also:

• createScript(String, java.util.Map, boolean)

createScript

Script createScript(String uid,
 @Nullable
 @Nullable Map<Language,String> lang2DisplayName,
 boolean unifyUid)
             throws LockException,
DuplicateReferenceNameException,
ElementDeletedException

Creates a new Script as child of this ScriptContainer

Parameters:

uid - the uid of the new Script

lang2DisplayName - mapping of language to language specific displayname; used to create LanguageInfo nodes

unifyUid - if false a DuplicateReferenceNameException may be thrown , if true the name will be unified on the server if necessary

Returns:

the new script

Throws:

LockException - if this script container is locked in another session

DuplicateReferenceNameException - if unifyNameOnServer is false and an element with the given uid in the same namescope already exits on the server

ElementDeletedException

Since:

4.0.29

getAllScripts

@Deprecated
List<Script> getAllScripts()

Deprecated.

since 5.0.100 - use getChildren(Script.class), true instead

Returns a list of all scripts of this script container. Shortcut for StoreElement.getChildren(Script.class, true)

Returns:

a list of all scripts

Since:

3.0

getScriptByName

Script getScriptByName(String uid)

Returns the script specified by the given uid or null if no script with given uid exists as child of this script container

Parameters:

uid - to specify the script to search for

Returns:

the script specified by given uid or null

Since:

3.0