com.ibm.itim.apps.workflow
Class WorkflowAssignmentMO

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

public class WorkflowAssignmentMO
extends java.lang.Object

This class provides management capabilities for an assignment, or work item.


Constructor Summary
WorkflowAssignmentMO(PlatformContext platform, javax.security.auth.Subject subject, long id)
          Constructs the the managed object with a platform context, a subject, and the managed object representing the workflow assignment.
 
Method Summary
 void complete()
          Signals completion of the assignment 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.
 WorkflowActivityMO getActivity()
          Returns the activity that generated this assignment.
 Assignment getData()
          Returns the value object holding details about this assignment.
 long getID()
          Returns the identifier of the assignment.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkflowAssignmentMO

public WorkflowAssignmentMO(PlatformContext platform,
                            javax.security.auth.Subject subject,
                            long id)
Constructs the the managed object with a platform context, a subject, and the managed object representing the workflow assignment.
Parameters:
platform - PlatformContext holding platform connection information.
subject - Subject representing the authenticated caller.
id - long representing the id of the assignment.
Method Detail

getID

public long getID()
Returns the identifier of the assignment.
Returns:
ID of the assignment.

getActivity

public WorkflowActivityMO getActivity()
                               throws java.rmi.RemoteException,
                                      ApplicationException
Returns the activity that generated this assignment.
Returns:
WorkflowActivityMO that generated the assignment.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.
ApplicationException - Thrown if unable to retrieve the activity.

complete

public void complete()
              throws java.rmi.RemoteException,
                     AuthorizationException,
                     ApplicationException
Signals completion of the assignment to the workflow engine.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.
AuthorizationException - Thrown if client is unauthorized to complete the assignment.
ApplicationException - Thrown if an error occured trying to process the completion.

complete

public void complete(ActivityResult result)
              throws java.rmi.RemoteException,
                     AuthorizationException,
                     ApplicationException
Signals completion of the activity to the workflow engine and provides the engine with the activity result in the same call.
Parameters:
result - ActivityResult holding the result of the activity.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.
AuthorizationException - Thrown if client is unauthorized to complete the activity.
ApplicationException - Thrown if an error occured trying to process the completion.

getData

public Assignment getData()
                   throws java.rmi.RemoteException,
                          ApplicationException
Returns the value object holding details about this assignment.
Returns:
Assignment value object.
Throws:
java.rmi.RemoteException - Thrown if unable to communicate with platform.
ApplicationException - Thrown if unable to retrieve the assignment's value object.