com.ibm.itim.apps.workflow
Class WorkflowActivityMO

java.lang.Object
  |
  +--com.ibm.itim.apps.workflow.WorkflowExecutionMO
        |
        +--com.ibm.itim.apps.workflow.WorkflowActivityMO

public class WorkflowActivityMO

extends WorkflowExecutionMO

Provides management capabilities for an activity in a workflow process such as retrieving activity details, retrieving parent container process, retrieving assignments of this activity, completing activity asynchronously.

Constructor Summary

WorkflowActivityMO(PlatformContext platform, javax.security.auth.Subject subject, long id)
Constructs the the managed object with a platform context and a subject.

Method Summary

void	auditEvent(EventAudit event) Places the given event in the audit trail (history) of the execution object.
void	complete() Signals completion of the activity to the workflow engine.
void	complete(ActivityResult result) Signals completion of the activity to the workflow engine and provides the engine with the activity result in the same call.
java.util.Collection	getAssignments() Returns the assignments made to resources as part of this activity.
WorkflowProcessMO	getContainer() Returns the containing process of the activity.
Activity	getData() Returns the details about this activity.
java.util.List	getHistory() Returns the history, or the audit trail for this activity.
void	setResult(ActivityResult result) Changes the result of the activity.

Methods inherited from class com.ibm.itim.apps.workflow.WorkflowExecutionMO

getID

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowActivityMO

public WorkflowActivityMO(PlatformContext platform,
                          javax.security.auth.Subject subject,
                          long id)

Constructs the the managed object with a platform context and a subject.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Subject representing the authenticated caller.

id - long representing the id of the activity.

Method Detail

complete

public void complete()
              throws java.rmi.RemoteException,
                     ApplicationException

Signals completion of the activity to the workflow engine. This is called when the client request to complete the pending activity with a ActivityResult.STATUS_COMPLETE completion status and (@link ActivityResult#SUCCESS} summary result.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if an error occured trying to process the completion.

complete

public void complete(ActivityResult result)
              throws java.rmi.RemoteException,
                     ApplicationException

Signals completion of the activity to the workflow engine and provides the engine with the activity result in the same call. This is called when the client request to complete the pending activity.

Parameters:

result - ActivityResult holding the result of the activity.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if an error occured trying to process the completion.

getHistory

public java.util.List getHistory()
                          throws java.rmi.RemoteException,
                                 ApplicationException

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

Specified by:

getHistory in class WorkflowExecutionMO

Returns:

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

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

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

auditEvent

public void auditEvent(EventAudit event)
                throws java.rmi.RemoteException,
                       ApplicationException

Places the given event in the audit trail (history) of the execution object.

Specified by:

auditEvent in class WorkflowExecutionMO

Parameters:

event - EventAudit representing the audited event.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if an error was encountered trying to audit the event.

setResult

public void setResult(ActivityResult result)
               throws java.rmi.RemoteException,
                      ApplicationException

Changes the result of the activity.

Parameters:

result - ActivityResult holding the result of the activity.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if an error occured trying to change the result.

getAssignments

public java.util.Collection getAssignments()
                                    throws java.rmi.RemoteException,
                                           ApplicationException

Returns the assignments made to resources as part of this activity.

Returns:

Collection of WorkflowAssignmentMO.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if unable to retrieve the activity's assignments.

getContainer

public WorkflowProcessMO getContainer()
                               throws java.rmi.RemoteException,
                                      ApplicationException

Returns the containing process of the activity.

Returns:

WorkflowProcessMO of the containing process.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if unable to retrieve the activity's containing process.

getData

public Activity getData()
                 throws java.rmi.RemoteException,
                        ApplicationException

Returns the details about this activity.

Returns:

Activity details.

Throws:

java.rmi.RemoteException - Thrown if unable to communicate with platform.

ApplicationException - Thrown if unable to retrieve the activity details.