com.ibm.itim.workflow.model
Class Activity

java.lang.Object
  |
  +--com.ibm.itim.workflow.model.ExecutionObject
        |
        +--com.ibm.itim.workflow.model.Activity

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

Direct Known Subclasses:

PendingActivity

public class Activity

extends ExecutionObject

This class provides general information about a workflow actvity.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.itim.workflow.model.ExecutionObject

ABORTED, BYPASSED, COMPLETED, DEFAULT_PRIORITY, NOTSTARTED, RUNNING, SUSPENDED, TERMINATED

Constructor Summary

Activity()

Method Summary

java.lang.String	getActivitySubType() Returns the sub-type of this activity.
java.lang.String	getActivityType() Return the type of this activity.
java.lang.String	getDesignId() Returns the ID of the activity as defined at design time.
int	getIndex() Returns the index of this activity.
long	getProcessId() Returns the ID of the process that is running this activity.
long	getSubProcessId() Returns the ID of the sub-process that is running this activity.
void	setActivitySubType(java.lang.String activitySubType) Changes the sub-type of the activity.
void	setActivityType(java.lang.String activityType) Changes the type of the activity.
void	setDesignId(java.lang.String id) Changes the design time ID of the activity.
void	setIndex(int index) Changes the index of the activity.
void	setProcessId(long processId) Changes the ID of the parent process.
void	setSubProcessId(long subProcessId) Changes the ID of the sub-process.
java.lang.String	toString()

Methods inherited from class com.ibm.itim.workflow.model.ExecutionObject

compareTo, getDescription, getId, getLastModified, getName, getPriority, getResult, getResultDetail, getState, getTimeCompleted, getTimeStarted, isFinished, setDescription, setId, setLastModified, setName, setPriority, setResult, setResultDetail, setState, setTimeCompleted, setTimeStarted

Methods inherited from class java.lang.Object

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

Constructor Detail

Activity

public Activity()

Method Detail

getDesignId

public java.lang.String getDesignId()

Returns the ID of the activity as defined at design time.

Returns:

Design time id of the activity.

setDesignId

public void setDesignId(java.lang.String id)

Changes the design time ID of the activity.

Parameters:

id - String ID of the activity.

getProcessId

public long getProcessId()

Returns the ID of the process that is running this activity.

Returns:

ID of the parent process.

setProcessId

public void setProcessId(long processId)

Changes the ID of the parent process.

Parameters:

processId - ID of the parent process.

getSubProcessId

public long getSubProcessId()

Returns the ID of the sub-process that is running this activity.

Returns:

ID of the sub-process.

setSubProcessId

public void setSubProcessId(long subProcessId)

Changes the ID of the sub-process.

Parameters:

subProcessId - ID of the sub-process.

getIndex

public int getIndex()

Returns the index of this activity. The index identifies the instance of the activity if there is more than one instance of the activity, such as in the case where the activity is called multiple times in a loop in the workflow process. If there is only one instance of the activity, the index value will be zero.

Returns:

Index of the activity.

setIndex

public void setIndex(int index)

Changes the index of the activity. The index identifies the instance of the activity if there is more than one instance of the activity, such as in the case where the activity is called multiple times in a loop in the workflow process. If there is only one instance of the activity, the index value will be zero.

Parameters:

index - Index of the activity.

getActivityType

public java.lang.String getActivityType()

Return the type of this activity.

Returns:

Type of the activity.

setActivityType

public void setActivityType(java.lang.String activityType)

Changes the type of the activity.

Parameters:

activityType - Type of the activity.

getActivitySubType

public java.lang.String getActivitySubType()

Returns the sub-type of this activity. Note: not all activities have a subtype. Those activities will return an empty string.

Returns:

Sub-type of the activity, the empty string if not applicable.

setActivitySubType

public void setActivitySubType(java.lang.String activitySubType)

Changes the sub-type of the activity.

Parameters:

activitySubType - Sub-type of the activity.

toString

public java.lang.String toString()

Overrides:

toString in class ExecutionObject