com.canto.cumulus.prefs

Class WorkflowActivities

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.WorkflowActivities

public class WorkflowActivities
extends BaseManager

This class stores the activities 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
WorkflowActivity	createWorkflowActivity(java.lang.String defaultName) Adds a new activity.
void	deleteWorkflowActivity(WorkflowActivity value) Delete the given activity.
java.util.List<WorkflowActivity>	getWorkflowActivities() Returns a list of all contained activities.
java.util.List<WorkflowActivity>	getWorkflowActivities(UserContext userContext) Returns a list of all contained activities.
WorkflowActivity	getWorkflowActivity(int activityID) Returns the activity for the given ID.
java.util.Set<java.lang.Integer>	getWorkflowActivityIDs(boolean initialActivitiesOnly) Returns all available activity IDs of this instance.
java.util.Set<java.lang.Integer>	getWorkflowActivityIDs(int stateID) Returns all available activity IDs of this instance for the given state id.

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

createWorkflowActivity

public WorkflowActivity createWorkflowActivity(java.lang.String defaultName)

Adds a new activity.

Parameters:

defaultName - the default name for the new activity

Returns:

the new created activity

getWorkflowActivity

public WorkflowActivity getWorkflowActivity(int activityID)

Returns the activity for the given ID.

Parameters:

activityID - ID of the activity to get

Returns:

the found activity or null if not found

deleteWorkflowActivity

public void deleteWorkflowActivity(WorkflowActivity value)

Delete the given activity.

Parameters:

value - activity to delete.

getWorkflowActivities

public java.util.List<WorkflowActivity> getWorkflowActivities()

Returns a list of all contained activities.

Returns:

all activities available or an empty list

getWorkflowActivities

public java.util.List<WorkflowActivity> getWorkflowActivities(UserContext userContext)

Returns a list of all contained activities.

Parameters:

userContext - The user context to only return activities that are allowed to be applied by this user. Pass null to return all activities.

Returns:

all activities available or an empty list

getWorkflowActivityIDs

public java.util.Set<java.lang.Integer> getWorkflowActivityIDs(boolean initialActivitiesOnly)

Returns all available activity IDs of this instance.

Parameters:

initialActivitiesOnly - true if only initial activities should be returned, otherwise false

Returns:

all available IDs or an empty set

getWorkflowActivityIDs

public java.util.Set<java.lang.Integer> getWorkflowActivityIDs(int stateID)

Returns all available activity IDs of this instance for the given state id.

Parameters:

stateID - state id to return the accepted activity IDs for

Returns:

all available IDs for the given state ID or an empty set