Package com.groiss.wf

Interface ActivityInstance

All Superinterfaces:
Serializable
All Known Subinterfaces:
ProcessInstance
public interface ActivityInstance extends Serializable
The activity instance represents a step of a process instance. This interface contains only getters, use the WfEngine interface to manipulate this object.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    ActivityInstance.LastAction
    Defines the last action of the activity.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
    ABORTED
    Instance has been aborted.
    static final short
    ACTIVE
    Instance is active.
    static final int
    ALL
     
    static final int
    ANDJOIN
    An andjoin node, end of andpar.
    static final int
    BATCH
    batch
    static final int
    BEGIN
    A begin node.
    static final int
    BRANCH
    A branch node.
    static final int
    CHOICE
    Start of a choice construct.
    static final int
    CHOICE_BRANCH
    A branch of a choice.
    static final short
    COMPENSATED
    Instance has been compensated.
    static final short
    COMPENSATING
    Step is currently beeing compensated
    static final int
    ELSIF
    An else-if node.
    static final int
    END
    An end node.
    static final int
    END_BRANCH
    A branch end node.
    static final int
    END_COMPENSATION
     
    static final int
    END_SCOPE
    end scope
    static final int
    ENDFOR
    parallel for end
    static final short
    ERROR
    Step is in error state
    static final int
    EXIT_WHEN
    An exit-when node.
    static final short
    FINISHED
    Instance is finished.
    static final int
    GOTO
    A goto node.
    static final int
    IF
    An if node.
    static final int
    LOOP
    A loop node, starts a loop construct.
    static final short
    ORIGIN_AUGMENTATION
    The user sees the instance via an augmented worklist
    static final short
    ORIGIN_DIRECT
    The user sees the instance because of assignment to himself or one of his roles
    static final short
    ORIGIN_SUBSTITUTION
    The user sees the instance via substitution
    static final short
    ORIGIN_UNKNOWN
    The origin of the instance is unknown
    static final int
    ORJOIN
    An orjoin node, end of orpar.
    static final int
    PAR
    A par node, start of orpar or andpar.
    static final int
    PARFOR
    parallel for
    static final int
    PROCESS
    A (sub)process node.
    static final int
    SCOPE
    start a new scope
    static final short
    STARTED
    Instance is in idle state.
    static final short
    SUSPENDED
    Instance is in suspension list.
    static final int
    SYSTEM_INTERN
    A system step which is translated in another wdl expression, e.g. raiseEvent
    static final int
    SYSTEM_TASK
    A system task.
    static final int
    SYSTEM_WAIT
    A system step which makes no finish
    static final int
    TASK
    A task node.
    static final int
    WAIT
     
    static final short
    WAITING
    Instance is finished, but post finish actions are pending (for example selection of choice path).
    static final int
    WHILE
    A while node.
    static final int
    WS_INVOKE
     
    static final int
    WS_RECEIVE
     
    static final int
    WS_REPLY
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Agent
    getAgent()
    Returns the agent of the object
    Application
    getApplication()
    Returns the application the activity belogs to.
    String
    getDescription()
    Returns the description
    Date
    getDuedate()
    Returns the duedate
    Date
    getFinished()
    Returns the finish date.
    String
    getId()
    Returns the id of the activity instance.
    ActivityInstance.LastAction
    getLastAction()
    Returns a enum for the last action that changed the state of this ai
    long
    getOid()
    Returns the unique oid of the object.
    OrgUnit
    getOrgUnit()
    Returns the organizational unit.
    short
    getOrigin()
    Returns the origin of this ActivityInstance.
    ActivityInstance
    getParent()
    Returns the parent node in the process execution graph, normally the process instance, but for example in parfors, the parfor node
    ProcessDefinition
    getProcessDefinition()
    Returns the process definition the activity instance belongs to.
    ProcessInstance
    getProcessInstance()
    Returns the process instance the activity instance belongs to.
    Date
    getStarted()
    Returns the start date.
    short
    getStatus()
    Returns the status of the activity instance.
    Agent
    getStepAgent()
    Returns the step-agent of the object.
    String
    getStepLabel()
    Get the label of the step the activity instance belongs to.
    String
    getStepName()
    Get the name of the step the activity belongs to.
    Date
    getTaken()
    Returns the date when a user has taken the activity.
    Task
    getTask()
    Returns the task
    int
    getType()
    Returns the type of the activity instance.
    UserFolder
    getUserFolder()
    Returns the UserFolder of the ActivityInstance.
    boolean
    isInGoBack()
    Returns true if the activity instance has been created in a go back action.
    boolean
    isInReactivate()
    Returns true if the activity instance has been created in a reactivate action.
    List<DMSNote>
    listSystemNotes()
    Get all SystemNotes, which are attached to this activityinstance

  • Field Details

  • Method Details

    • getOid

      long getOid()
      Returns the unique oid of the object.
      Returns:
      the oid

    • getAgent

      Agent getAgent()
      Returns the agent of the object
      Returns:
      the agent (User or Role)

    • getStepAgent

      Agent getStepAgent()
      Returns the step-agent of the object. This is the agent, as it appears in the process definition, normally a role
      Returns:
      the step-agent (User or Role)

    • getStarted

      Date getStarted()
      Returns the start date.
      Returns:
      a date object

    • getTaken

      Date getTaken()
      Returns the date when a user has taken the activity.
      Returns:
      a date object or null if not yet taken.

    • getFinished

      Date getFinished()
      Returns the finish date.
      Returns:
      a date object, is null when the activity is not finished.

    • getDuedate

      Date getDuedate()
      Returns the duedate
      Returns:
      a date, null when no duedate is set.

    • getDescription

      String getDescription()
      Returns the description
      Returns:
      a string object, may be null

    • getStatus

      short getStatus()
      Returns the status of the activity instance. See the programming guide for the possible values.
      Returns:
      the status

    • getOrgUnit

      OrgUnit getOrgUnit()
      Returns the organizational unit.
      Returns:
      the OrgUnit

    • getApplication

      Application getApplication()
      Returns the application the activity belogs to.
      Returns:
      the application

    • getType

      int getType()
      Returns the type of the activity instance.
      Returns:
      the type

    • getTask

      Task getTask()
      Returns the task
      Returns:
      the task, may be null if activity instance is not of type task.

    • getProcessDefinition

      ProcessDefinition getProcessDefinition()
      Returns the process definition the activity instance belongs to.
      Returns:
      the process definition

    • getProcessInstance

      ProcessInstance getProcessInstance()
      Returns the process instance the activity instance belongs to.
      Returns:
      the process instance

    • getStepName

      String getStepName()
      Get the name of the step the activity belongs to.
      Returns:
      the step name, may be null.

    • getStepLabel

      String getStepLabel()
      Get the label of the step the activity instance belongs to.
      Returns:
      the step label, may be null.

    • getParent

      ActivityInstance getParent()
      Returns the parent node in the process execution graph, normally the process instance, but for example in parfors, the parfor node
      Returns:
      an activity instance

    • getOrigin

      short getOrigin()
      Returns the origin of this ActivityInstance. Works only when the Instance was retrieved via the WorklistCache.
      Returns:
      ORIGIN_UNKNOWN, ORIGIN_DIRECT, ORIGIN_SUBSTITUTION, or ORIGIN_AUGMENTATION

    • isInGoBack

      boolean isInGoBack()
      Returns true if the activity instance has been created in a go back action.

    • isInReactivate

      boolean isInReactivate()
      Returns true if the activity instance has been created in a reactivate action.

    • getId

      String getId()
      Returns the id of the activity instance.
      Returns:
      the id

    • listSystemNotes

      List<DMSNote> listSystemNotes()
      Get all SystemNotes, which are attached to this activityinstance
      Returns:
      a list of systemnotes attached to this activityinstance

    • getLastAction

      ActivityInstance.LastAction getLastAction()
      Returns a enum for the last action that changed the state of this ai

    • getUserFolder

      UserFolder getUserFolder()
      Returns the UserFolder of the ActivityInstance.
      Returns:
      the UserFolder the ActivityInstance is in