xflow.common
Class WorkflowState

java.lang.Object
  |
  +--xflow.common.WorkflowState
All Implemented Interfaces:
java.io.Serializable

public class WorkflowState
extends java.lang.Object
implements java.io.Serializable

This class represents the workflow's state - its variables and participant process states

See Also:
Serialized Form

Field Summary
 java.util.Vector activeProcesses
           
 java.lang.String initiator
           
 boolean isActive
           
 java.lang.String state
           
 java.util.Date timeEnded
           
 java.util.Date timeStarted
           
 java.util.HashMap variables
           
 int version
           
 xflow.common.WorkflowId workflowId
           
 java.lang.String workflowName
           
 
Constructor Summary
WorkflowState()
          Constructor
 
Method Summary
 java.util.Vector getActiveProcesses()
          Gets the vector of ProcessState objects of active processes
 java.lang.String getInitiator()
          Returns the initiator
 boolean getIsActive()
          Gets the active status
 java.lang.String getState()
          Returns the workflow state
 java.util.Date getTimeEnded()
          Gets the time ended
 java.util.Date getTimeStarted()
          Gets the time started
 java.util.HashMap getVariables()
          Gets the variables hash map
 xflow.common.WorkflowId getWorkflowId()
          Gets a workflow ID
 java.lang.String getWorkflowName()
          Returns the workflow name
 int getWorkflowVersion()
          Returns the workflow version
 void setActiveProcesses(java.util.Vector v)
          Sets the vector of ProcessState objects of active processes
 void setInitiator(java.lang.String s)
          Sets the initiator
 void setIsActive(boolean b)
          Sets the active status
 void setState(java.lang.String s)
          Sets a workflow state
 void setTimeEnded(java.util.Date ts)
          Sets the time ended
 void setTimeStarted(java.util.Date ts)
          Sets the time started
 void setVariables(java.util.HashMap v)
          Sets the variables hash map
 void setWorkflowId(xflow.common.WorkflowId wfid)
          Sets a workflow ID
 void setWorkflowName(java.lang.String name)
          Sets a workflow name
 void setWorkflowVersion(int v)
          Sets a workflow version
 java.lang.String toString()
          Gets the string representation of this object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

workflowId

public xflow.common.WorkflowId workflowId

workflowName

public java.lang.String workflowName

version

public int version

isActive

public boolean isActive

state

public java.lang.String state

initiator

public java.lang.String initiator

timeStarted

public java.util.Date timeStarted

timeEnded

public java.util.Date timeEnded

variables

public java.util.HashMap variables

activeProcesses

public java.util.Vector activeProcesses
Constructor Detail

WorkflowState

public WorkflowState()
Constructor

Method Detail

setWorkflowId

public void setWorkflowId(xflow.common.WorkflowId wfid)
Sets a workflow ID


getWorkflowId

public xflow.common.WorkflowId getWorkflowId()
Gets a workflow ID

Returns:
workflowId the workflow ID

setWorkflowName

public void setWorkflowName(java.lang.String name)
Sets a workflow name

Parameters:
name - the workflow name

getWorkflowName

public java.lang.String getWorkflowName()
Returns the workflow name

Returns:
workflowName the workflow name

setWorkflowVersion

public void setWorkflowVersion(int v)
Sets a workflow version

Parameters:
v - the workflow version

getWorkflowVersion

public int getWorkflowVersion()
Returns the workflow version


setState

public void setState(java.lang.String s)
Sets a workflow state

Parameters:
s - the workflow state name

getState

public java.lang.String getState()
Returns the workflow state

Returns:
workflowState the workflow state name

setInitiator

public void setInitiator(java.lang.String s)
Sets the initiator

Parameters:
s - the initiator (user)

getInitiator

public java.lang.String getInitiator()
Returns the initiator

Returns:
initiator the user who initiated the workflow

setIsActive

public void setIsActive(boolean b)
Sets the active status

Parameters:
b - the active status

getIsActive

public boolean getIsActive()
Gets the active status

Returns:
the active status

setTimeStarted

public void setTimeStarted(java.util.Date ts)
Sets the time started


getTimeStarted

public java.util.Date getTimeStarted()
Gets the time started

Returns:
the start time

setTimeEnded

public void setTimeEnded(java.util.Date ts)
Sets the time ended


getTimeEnded

public java.util.Date getTimeEnded()
Gets the time ended

Returns:
the end time

setVariables

public void setVariables(java.util.HashMap v)
Sets the variables hash map

Parameters:
v - the variables hash map

getVariables

public java.util.HashMap getVariables()
Gets the variables hash map

Returns:
the variables hash map

setActiveProcesses

public void setActiveProcesses(java.util.Vector v)
Sets the vector of ProcessState objects of active processes

Parameters:
v - the vector of ProcessState objects

getActiveProcesses

public java.util.Vector getActiveProcesses()
Gets the vector of ProcessState objects of active processes

Returns:
the vector of ProcessState objects

toString

public java.lang.String toString()
Gets the string representation of this object

Overrides:
toString in class java.lang.Object
Returns:
the string representation