com.ibm.itim.workflow.model
Class AssignmentEntity

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

public class AssignmentEntity
extends java.lang.Object

Class that provides management capabilities for an Assignment in a workflow Activity.


Constructor Summary
AssignmentEntity(Assignment assignment)
          Constructs with Assignment value object.
 
Method Summary
 void complete(DistinguishedName user)
          Signals completion of the assignment to the workflow engine.
 void complete(DistinguishedName user, ActivityResult result)
          Signals completion of the assignment to the workflow engine and provides the engine with the activity result in the same call.
 ActivityEntity getActivity()
          Returns the activity associated with this assignment.
static AssignmentEntity getAssignment(long assignmentId)
          Returns an assignment associated with the id.
 java.util.List getInputParameters()
          Returns list of input parameters for this assignment.
 Assignment getValueObject()
          Returns the value object holding details about this assignment.
 void setValueObject(Assignment assignment)
          Sets the value object holding details about this assignment.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AssignmentEntity

public AssignmentEntity(Assignment assignment)
Constructs with Assignment value object.
Method Detail

complete

public void complete(DistinguishedName user)
              throws WorkflowException
Signals completion of the assignment to the workflow engine.
Parameters:
user - Participant of the assignment.
Throws:
WorkflowException - Thrown if an error occured trying to process the completion.

complete

public void complete(DistinguishedName user,
                     ActivityResult result)
              throws WorkflowException
Signals completion of the assignment to the workflow engine and provides the engine with the activity result in the same call.
Parameters:
user - Participant of the assignment.
result - ActivityResult holding the result of the completing assignment.
Throws:
WorkflowException - Thrown if an error occured trying to process the completion.

getAssignment

public static AssignmentEntity getAssignment(long assignmentId)
                                      throws WorkflowException
Returns an assignment associated with the id.
Parameters:
assignmentId - Id of the assignment
Returns:
AssignmentEntity object.
Throws:
WorkflowException - Thrown if unable to retrieve the assignment.

getActivity

public ActivityEntity getActivity()
                           throws WorkflowException
Returns the activity associated with this assignment.
Returns:
ActivityEntity of the associated assignment.
Throws:
WorkflowException - Thrown if unable to retrieve the activity.

getInputParameters

public java.util.List getInputParameters()
                                  throws WorkflowException
Returns list of input parameters for this assignment.
Returns:
List of input parameters.
Throws:
WorkflowException - Thrown if unable to retrieve the input parameters.

getValueObject

public Assignment getValueObject()
Returns the value object holding details about this assignment.
Returns:
Assignment value object.

setValueObject

public void setValueObject(Assignment assignment)
Sets the value object holding details about this assignment.
Parameters:
valueObject - Assignment value object.