com.canto.cumulus.prefs

Class Workflow

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.Workflow

All Implemented Interfaces:

Item

public class Workflow
extends BaseManager
implements Item

This class stores the settings for a single workflow.

Since:

9.2

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
JPack	exportSet() Exports this set into a JPack.
GUID	getActivitiesTableFieldUID() Returns the uid to use for the activities table of instances of this workflow.
GUID	getAssignmentsTableFieldUID() Returns the uid to use for the assignments table of instances of this workflow.
java.util.Date	getChangeTimestamp() Return the date of the last change of this workflow definition.
java.lang.String	getDescription(int languageID) Returns the description for the given language id.
java.lang.String	getDisplayName(int languageID, boolean fallbackToDefaultName) Returns the display name for the given language id.
java.lang.String	getID() Returns the UID of the item in the items namespace.
boolean	getIsDefault() Returns whether this is the default workflow.
java.lang.String	getName() Returns the name of this workflow.
RestrictionsList	getRestrictionsList() Returns the list of roles and users that are allowed to view this workflow.
WorkflowActivities	getWorkflowActivities() Returns the list of workflow activities.
GUID	getWorkflowID() Returns the workflow id of this workflow.
WorkflowStates	getWorkflowStates() Returns the workflow states.
boolean	isDefault() Returns whether this item is the default item.
boolean	isSharingRestricted() Returns whether the set visibility is restricted to a group of users or roles.
void	setDescription(int languageID, java.lang.String description) Sets the description for the given language.
void	setDisplayName(int languageID, java.lang.String displayName) Sets the display name for the given language.
void	setSharingRestricted(boolean value) Sets whether the set visibility is restricted to a group of users or roles.
java.lang.String	validate(int languageID, CumulusSession cumulusSession) Validates this workflow for being correct.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getWorkflowID

public GUID getWorkflowID()

Returns the workflow id of this workflow.

Returns:

id of this workflow

getActivitiesTableFieldUID

public GUID getActivitiesTableFieldUID()

Returns the uid to use for the activities table of instances of this workflow.

Returns:

uid to use for the activities table of instances of this workflow

getAssignmentsTableFieldUID

public GUID getAssignmentsTableFieldUID()

Returns the uid to use for the assignments table of instances of this workflow.

Returns:

uid to use for the assignments table of instances of this workflow

getName

public java.lang.String getName()

Returns the name of this workflow.

Returns:

name of this workflow

getIsDefault

public boolean getIsDefault()

Returns whether this is the default workflow.

Returns:

true if this is the default workflow

getID

public java.lang.String getID()

Description copied from interface: Item

Returns the UID of the item in the items namespace.

Specified by:

getID in interface Item

Returns:

item UID

isDefault

public boolean isDefault()

Description copied from interface: Item

Returns whether this item is the default item.

Specified by:

isDefault in interface Item

Returns:

true if this is the default item

getWorkflowStates

public WorkflowStates getWorkflowStates()

Returns the workflow states.

Returns:

workflow states

getWorkflowActivities

public WorkflowActivities getWorkflowActivities()

Returns the list of workflow activities.

Returns:

the list of workflow activities

exportSet

public JPack exportSet()

Exports this set into a JPack.

Specified by:

exportSet in interface Item

Returns:

exported data as JPack

See Also:

WorkflowList.importSet(com.canto.cumulus.utils.JPack, com.canto.cumulus.prefs.SetImportDuplicatesMode)

getDescription

public java.lang.String getDescription(int languageID)

Returns the description for the given language id.

Specified by:

getDescription in interface Item

Parameters:

languageID - specifying the language for the description

Returns:

description text

setDescription

public void setDescription(int languageID,
                  java.lang.String description)

Sets the description for the given language.

Specified by:

setDescription in interface Item

Parameters:

languageID - the language to set the description for

description - the new description

getDisplayName

public java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)

Returns the display name for the given language id.

Specified by:

getDisplayName in interface Item

Parameters:

languageID - specifying the language for the display name

fallbackToDefaultName - when set to true this method returns the default name when now localized display name is available otherwise null

Returns:

display name

setDisplayName

public void setDisplayName(int languageID,
                  java.lang.String displayName)

Sets the display name for the given language.

Specified by:

setDisplayName in interface Item

Parameters:

languageID - the language to set the display name for

displayName - the new display name

isSharingRestricted

public boolean isSharingRestricted()

Returns whether the set visibility is restricted to a group of users or roles.

Specified by:

isSharingRestricted in interface Item

Returns:

true if the set visibility is restricted to a group of users or roles

setSharingRestricted

public void setSharingRestricted(boolean value)

Sets whether the set visibility is restricted to a group of users or roles.

Specified by:

setSharingRestricted in interface Item

Parameters:

value - set to true if the set visibility should be restricted to a group of users or roles

getRestrictionsList

public RestrictionsList getRestrictionsList()

Returns the list of roles and users that are allowed to view this workflow. Only applicable for shared set and if isSharingRestricted() returns true.

Specified by:

getRestrictionsList in interface Item

Returns:

list of roles and users that are allowed to view this workflow

validate

public java.lang.String validate(int languageID,
                        CumulusSession cumulusSession)

Validates this workflow for being correct. Detected inconsistencies are unreachable states, activities with no valid source or destination state and a workflow without at least one initial activity.

Parameters:

languageID - language for the returned error message

cumulusSession - provide an instance to check the linked sets for existence or null to skip that check

Returns:

the found problem or null

getChangeTimestamp

public java.util.Date getChangeTimestamp()

Return the date of the last change of this workflow definition.

Returns:

date of the last change of this workflow definition