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

Interface WorkflowContainer

All Superinterfaces:

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

All Known Subinterfaces:

WorkflowFolder, Workflows

public interface WorkflowContainer
extends IDProvider

Interface providing methods for elements which can have workflows and WorkflowFolder 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
Workflow	createWorkflow(String uid, String description)	Creates a new workflow with the given uid and description as child of this workflow container.
Workflow	createWorkflow(String name, String description, boolean unify)	Creates a new workflow with the given uid and description as child of this workflow container.
WorkflowFolder	createWorkflowFolder(String name)	Creates a new workflow folder with the given name as child of this workflow container.
WorkflowFolder	createWorkflowFolder(String name, @Nullable Map<Language,String> lang2DisplayName)	Creates a new WorkflowFolder with the given name and displaynames as child of this workflow 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, 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.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, 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

createWorkflowFolder

WorkflowFolder createWorkflowFolder(String name)
                             throws LockException,
ElementDeletedException

Creates a new workflow folder with the given name as child of this workflow container.

Throws:

LockException

ElementDeletedException

Since:

3.0

See Also:

• createWorkflowFolder(String, java.util.Map)

createWorkflowFolder

WorkflowFolder createWorkflowFolder(String name,
 @Nullable
 @Nullable Map<Language,String> lang2DisplayName)
                             throws LockException,
ElementDeletedException

Creates a new WorkflowFolder with the given name and displaynames as child of this workflow container.

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

createWorkflow

Workflow createWorkflow(String uid,
 String description)
                 throws LockException,
DuplicateReferenceNameException,
ElementDeletedException

Creates a new workflow with the given uid and description as child of this workflow container. Calls createWorkflow(uid, description, false)

Throws:

DuplicateReferenceNameException - if an element with the given uid in the same namescope (Workflow.UID_TYPE) already exits on the server

LockException

ElementDeletedException

Since:

3.0

createWorkflow

Workflow createWorkflow(String name,
 String description,
 boolean unify)
                 throws LockException,
ElementDeletedException

Creates a new workflow with the given uid and description as child of this workflow container.

Throws:

DuplicateReferenceNameException - if unify == false and an element with the given uid in the same namescope (Workflow.UID_TYPE) already exits on the server

LockException

ElementDeletedException

Since:

4.0