org.apache.oodt.cas.workflow.lifecycle

Class WorkflowLifecycle

java.lang.Object

org.apache.oodt.cas.workflow.lifecycle.WorkflowLifecycle

public class WorkflowLifecycle
extends Object

Defines the lifecycle of a Workflow, identifying what WorkflowStatuses belong to a particular phase.

Version:

$Revision$

Author:

mattmann, bfoster

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LIFECYCLE
static String	NO_WORKFLOW_ID

Constructor Summary

Constructors

Constructor and Description
WorkflowLifecycle() Default Constructor.
WorkflowLifecycle(String name, String workflowId) Constructs a new WorkflowLifecycle with the given parameters.

Method Summary

Modifier and Type	Method and Description
void	addStage(WorkflowLifecycleStage stage) Adds a WorkflowStage to this WorkflowLifecycle.
void	clearStages() Clears the WorkflowStages in this WorkflowLifecycle.
WorkflowState	createState(String name, String category, String message)
WorkflowLifecycleStage	getCategoryByName(String category)
String	getName()
WorkflowLifecycleStage	getStageForWorkflow(String status) Deprecated.
SortedSet	getStages()
WorkflowState	getStateByName(String stateName) Looks up an associated WorkflowState by scanning the WorkflowLifecycleStages present in this lifecycle (aka, by scanning its "Categories", in Workflow2 terminology).
WorkflowState	getStateByNameAndCategory(String stateName, String category) Gets a WorkflowState by its name and WorkflowLifecycleStage (or Category in Workflow2 terminology).
String	getWorkflowId()
boolean	removeStage(WorkflowLifecycleStage stage) Removes the given WorkflowStage from this WorkflowLifecycle.
void	setName(String name)
void	setWorkflowId(String workflowId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LIFECYCLE

public static final String DEFAULT_LIFECYCLE

See Also:

Constant Field Values

NO_WORKFLOW_ID

public static final String NO_WORKFLOW_ID

See Also:

Constant Field Values

Constructor Detail

WorkflowLifecycle

public WorkflowLifecycle()

Default Constructor.

WorkflowLifecycle

public WorkflowLifecycle(String name,
                         String workflowId)

Constructs a new WorkflowLifecycle with the given parameters.

Parameters:

name - The name of the WorkflowLifecycle.

workflowId - The associated identifier for the Workflows that this WorkflowLifecycle is appropriate for.

Method Detail

getName

public String getName()

Returns:

the name

setName

public void setName(String name)

Parameters:

name - the name to set

getStages

public SortedSet getStages()

Returns:

the stages

addStage

public void addStage(WorkflowLifecycleStage stage)

Adds a WorkflowStage to this WorkflowLifecycle.

Parameters:

stage - The WorkflowStage to add to this WorkflowLifecycle.

removeStage

public boolean removeStage(WorkflowLifecycleStage stage)

Removes the given WorkflowStage from this WorkflowLifecycle.

Parameters:

stage - The WorkflowStage to remove.

Returns:

True on success, false on failure.

clearStages

public void clearStages()

Clears the WorkflowStages in this WorkflowLifecycle.

getWorkflowId

public String getWorkflowId()

Returns:

the workflowId

setWorkflowId

public void setWorkflowId(String workflowId)

Parameters:

workflowId - the workflowId to set

getStageForWorkflow

@Deprecated
public WorkflowLifecycleStage getStageForWorkflow(String status)

Deprecated.

Gets the associated WorkflowLifecycleStage for a WorkflowInstance with a given status.

Parameters:

status - The status of the WorkflowInstance to get the WorkflowLifecycleStage for.

Returns:

The corresponding WorkflowLifecycleStage for the WorkflowInstance with the given status, or null if that status does not exist in any defined WorkflowLifecycleStage .

getStateByName

public WorkflowState getStateByName(String stateName)

Looks up an associated WorkflowState by scanning the WorkflowLifecycleStages present in this lifecycle (aka, by scanning its "Categories", in Workflow2 terminology). Since no Category is provided, the first instance of a WorkflowState found in the given WorkflowLifecycleStage being scanned is returned, even if there are multiple instances of that state (e.g., others present in another category). If found, the WorkflowState is returned, otherwise null is returned.

Parameters:

stateName - The name of the WorkflowState to locate and return.

Returns:

The WorkflowState if found, otherwise null.

getStateByNameAndCategory

public WorkflowState getStateByNameAndCategory(String stateName,
                                               String category)

Gets a WorkflowState by its name and WorkflowLifecycleStage (or Category in Workflow2 terminology). If the state is found within that category, then it is returned, otherwise null is returned.

Parameters:

stateName - The name of the WorkflowState to locate and return.

category - The provided WorkflowLifecycleStage name to categorize the state by.

Returns:

The WorkflowState if found, otherwise null.

getCategoryByName

public WorkflowLifecycleStage getCategoryByName(String category)

createState

public WorkflowState createState(String name,
                                 String category,
                                 String message)