com.ibm.itim.workflow.model

Class ActivityEntity


  • public class ActivityEntity
extends ExecutionEntity
    Class that provides management capabilities for an activity in a workflow process

    • Constructor Summary

      Constructors 
      Constructor and Description
      ActivityEntity(Activity activity)
      Constructs with Activity value object.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      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.
      static ActivityEntity getActivity(long activityId)
      Returns the activity of the process with the given activity ID.
      java.util.Collection getAssignments()
      Returns the assignments made to resources as part of this activity.
      java.util.Collection getChildren()
      Returns the children processes of this activity (if any).
      WorkflowProcessEntity getContainer()
      Returns the containing process of the activity.
      java.util.List getHistory()
      Returns the history, or the audit trail for this activity.
      void setResult(java.lang.String summary, java.lang.String description)
      Changes the result of the activity.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ActivityEntity

        public ActivityEntity(Activity activity)
        Constructs with Activity value object.
        Parameters:
        activity -

    • Method Detail

      • complete

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

      • complete

        public void complete(ActivityResult result)
              throws WorkflowException
        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 completing assignment.
        Throws:
        WorkflowException - Thrown if an error occured trying to process the completion.

      • setResult

        public void setResult(java.lang.String summary,
                      java.lang.String description)
               throws WorkflowException
        Changes the result of the activity.
        Parameters:
        summary - Summary code for the activity.
        description - Description of the activity.
        Throws:
        WorkflowException - Thrown if an error occured trying to set the activity result.

      • getActivity

        public static ActivityEntity getActivity(long activityId)
                                  throws WorkflowException
        Returns the activity of the process with the given activity ID.
        Parameters:
        activityId - activity 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.

      • getHistory

        public java.util.List getHistory()
                          throws WorkflowException
        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 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.

      • getAssignments

        public java.util.Collection getAssignments()
                                    throws WorkflowException
        Returns the assignments made to resources as part of this activity.
        Returns:
        Collection of AssignmentEntity.
        Throws:
        WorkflowException - Thrown if unable to retrieve the activity's assignments.

      • getContainer

        public WorkflowProcessEntity getContainer()
                                   throws WorkflowException
        Returns the containing process of the activity.
        Returns:
        WorkflowProcessEntity of the containing process.
        Throws:
        WorkflowException - Thrown if unable to retrieve the activity's containing process.

      • getChildren

        public java.util.Collection getChildren()
        Returns the children processes of this activity (if any).
        Returns:
        Collection of WorkflowProcessEntity of the children process, empty collection if none found.
Skip navigation links