com.ibm.itim.workflow.model
Class WorkflowProcessEntity

java.lang.Object
  com.ibm.itim.workflow.model.ExecutionEntity
      com.ibm.itim.workflow.model.WorkflowProcessEntity

public class WorkflowProcessEntity
extends ExecutionEntity

Class that provides management capabilities for a workflow process.

Constructor Summary

WorkflowProcessEntity(WorkflowProcess wfProcess)
Constructs with WorkflowProcess value object.

Method Summary

void	abort() Aborts the Process.
void	abort(com.ibm.itim.apps.ejb.home.AuthenticationObject signedToken, java.lang.String justification) Aborts the Process.
java.util.Collection	getActivities() Returns the activities that are part of this process.
ActivityEntity	getActivity(java.lang.String designId) Returns the activity of the process with the given ID defined at design time.
ActivityEntity	getActivity(java.lang.String designId, int index) Returns the activity of the process with the given ID defined at design time and the given index of an iteration in a loop.
java.util.Collection	getChildren() Returns the children processes of this process (if any).
java.util.List	getHistory() Returns the history, or the audit trail for this process.
WorkflowProcessEntity	getParent() Returns the parent process of this process (if any).
java.util.Collection	getPendingManualActivities(int maxResult) Returns the activities that are part of this process.
java.util.Collection	getProcessContext() Returns the process context of the object.
RelevantDataItem	getProcessContext(java.lang.String dataId) Returns the relevant data from the process context of the object with the given ID.
void	setProcessContext(java.util.Collection context) Changes the process context of the object.
void	setProcessContext(RelevantDataItem contextItem) Changes the relevant data item within the process context of the object with the matching ID.
void	setResult(java.lang.String summary, java.lang.String description) Changes the result of the process.

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

auditEvent, getId, getValueObject, setValueObject

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowProcessEntity

public WorkflowProcessEntity(WorkflowProcess wfProcess)

Constructs with WorkflowProcess value object.

Parameters:

wfProcess - WorkflowProcess.

Method Detail

abort

public void abort()
           throws WorkflowException

Aborts the Process.

Throws:

WorkflowException - Thrown if an error was encountered trying to abort the process.

abort

public void abort(com.ibm.itim.apps.ejb.home.AuthenticationObject signedToken,
                  java.lang.String justification)
           throws WorkflowException

Aborts the Process.

Parameters:

signedToken - Signed object with DistinguishedName identifies an authenticated SystemUser.

justification - the reason to abort the process

Throws:

WorkflowException - Thrown if an error was encountered trying to abort the process.

setResult

public void setResult(java.lang.String summary,
                      java.lang.String description)

Changes the result of the process.

Parameters:

summary - Summary code for the process.

description - Description of the process.

getProcessContext

public java.util.Collection getProcessContext()
                                       throws WorkflowException

Returns the process context of the object. This is the complete set of relevant data used as the context of the object.

Returns:

Collection of RelevantDataItems representing the process context.

Throws:

WorkflowException - Thrown if an error was encountered trying to retrieve the context.

getProcessContext

public RelevantDataItem getProcessContext(java.lang.String dataId)
                                   throws WorkflowException

Returns the relevant data from the process context of the object with the given ID.

Returns:

RelevantDataItem with the matching ID, null if none found.

Throws:

WorkflowException - Thrown if an error was encountered trying to retrieve the context item.

setProcessContext

public void setProcessContext(java.util.Collection context)
                       throws WorkflowException

Changes the process context of the object. All relevant data with ID's that match those that are passed to this method will be changed to the given values.

Parameters:

context - Collection of RelevantDataItem to change.

Throws:

WorkflowException - Thrown if an error was encountered trying to change the context.

setProcessContext

public void setProcessContext(RelevantDataItem contextItem)
                       throws WorkflowException

Changes the relevant data item within the process context of the object with the matching ID.

Parameters:

contextItem - RelevantDataItem to change.

Throws:

WorkflowException - Thrown if an error was encountered trying to change the context item.

getPendingManualActivities

public java.util.Collection getPendingManualActivities(int maxResult)
                                                throws WorkflowException

Returns the activities that are part of this process.

Returns:

Collection of ActivityEntities.

Throws:

WorkflowException - Thrown if unable to retrieve the process's activities.

getActivities

public java.util.Collection getActivities()
                                   throws WorkflowException

Returns the activities that are part of this process.

Returns:

Collection of ActivityEntities.

Throws:

WorkflowException - Thrown if unable to retrieve the process's activities.

getActivity

public ActivityEntity getActivity(java.lang.String designId)
                           throws WorkflowException

Returns the activity of the process with the given ID defined at design time. If the activity is in a loop, the first iteration of the activity will be returned.

Parameters:

designId - Design time ID of the activity to retrieve.

Returns:

ActivityEntity with the matching ID.

Throws:

WorkflowException - Thrown if unable to retrieve the activity because of an invalid ID.

getActivity

public ActivityEntity getActivity(java.lang.String designId,
                                  int index)
                           throws WorkflowException

Returns the activity of the process with the given ID defined at design time and the given index of an iteration in a loop.

Parameters:

designId - Design time ID of the activity to retrieve.

index - Index of the loop iteration.

Returns:

ActivityEntity with the matching ID and loop index.

Throws:

WorkflowException - Thrown if unable to retrieve the activity because of an invalid ID or loop index.

getParent

public WorkflowProcessEntity getParent()
                                throws WorkflowException

Returns the parent process of this process (if any).

Returns:

WorkflowProcessEntity of the parent process, null if none found.

Throws:

WorkflowException - Thrown if unable to retrieve the process's parent process.

getChildren

public java.util.Collection getChildren()
                                 throws WorkflowException

Returns the children processes of this process (if any).

Returns:

Collection of WorkflowProcessEntity of the children process, null if none found.

Throws:

WorkflowException - Thrown if unable to retrieve the process's children process.

getHistory

public java.util.List getHistory()
                          throws WorkflowException

Returns the history, or the audit trail for this process. The history is made up of a sequential list of audit records (EventAudit objects).

Specified by:

getHistory in class ExecutionEntity

Returns:

List of EventAudit objects that represent the object's history.

Throws:

WorkflowException - Thrown if an error was encountered trying to retrieve the history.