com.ibm.bpe.api

Interface ProcessInstanceActions


  1. public interface ProcessInstanceActions
This interface defines symbolic constants for all actions that can be performed on process instances. These constants are to be used when determining the actions allowed in the current process instance execution state. Currently allowed actions are returned when calling the getAvailableActions() method on a process instance.
Since:
7.0 - introduced in 5.0

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
CLAIMPROCESSOWNERSHIP
Symbolic constant for process instance action claim process ownership
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. int
CREATEMESSAGE
Symbolic constant for process instance action create message.
  1. static
  2. int
CREATEWORKITEM
Symbolic constant for process instance action create work item.
  1. static
  2. int
DELETE
Symbolic constant for process instance action delete.
  1. static
  2. int
DELETEWORKITEM
Symbolic constant for process instance action delete work item.
  1. static
  2. int
FORCETERMINATE
Symbolic constant for process instance action force terminate.
  1. static
  2. int
FORCETERMINATEANDCOMPENSATE
Symbolic constant for process instance force terminate and compensate.
  1. static
  2. int
GETACTIVEEVENTHANDLER
Symbolic constant for process instance action get active event handlers.
  1. static
  2. int
GETACTIVITYINSTANCE
Symbolic constant for process instance action get avtivity instance.
  1. static
  2. int
GETALLACTIVITIES
Symbolic constant for process instance action get all activities.
  1. static
  2. int
GETALLVARIABLENAMES
Symbolic constant for process instance action get all variable names.
  1. static
  2. int
GETALLWORKITEMS
Symbolic constant for process instance action get all work items.
  1. static
  2. int
GETCORRELATIONSETINSTANCES
Symbolic constant for process instance action get correlation set instances
  1. static
  2. int
GETCUSTOMATTRIBUTE
Deprecated. Use GETCUSTOMPROPERTY.
  1. static
  2. int
GETCUSTOMPROPERTY
Symbolic constant for process instance action get customer property.
  1. static
  2. int
GETCUSTOMPROPERTYNAMES
Symbolic constant for process instance action get customer property names.
  1. static
  2. int
GETFAULTMESSAGE
Symbolic constant for process instance action get fault message.
  1. static
  2. int
GETINITIALVARIABLEVALUE
Symbolic constant for process instance action get initial variable value.
  1. static
  2. int
GETINPUTMESSAGE
Symbolic constant for process instance action get input message.
  1. static
  2. int
GETOUTPUTMESSAGE
Symbolic constant for process instance action get output message.
  1. static
  2. int
GETPROCESSINSTANCE
Symbolic constant for process instance action get process instance.
  1. static
  2. int
GETROLEINFO
Symbolic constant for process instance action to retrieve role related information.
  1. static
  2. int
GETUISETTINGS
Symbolic constant for process instance action get UI settings.
  1. static
  2. int
GETVARIABLE
Symbolic constant for process instance action get variable.
  1. static
  2. int
GETWORKITEMS
Symbolic constant for process instance action get workitems.
  1. static
  2. int
INITIALIZECORRELATIONSET
Symbolic constant for process instance action initialize correlation set
  1. static
  2. int
MIGRATE
Symbolic constant for process instance action migrate
  1. static
  2. int
RESTART
Symbolic constant for process instance action restart.
  1. static
  2. int
RESUME
Symbolic constant for process instance action resume.
  1. static
  2. int
SENDEVENT
Deprecated. As of version 7.5, no replacement.
  1. static
  2. int
SETCUSTOMATTRIBUTE
Deprecated. Use SETCUSTOMPROPERTY.
  1. static
  2. int
SETCUSTOMPROPERTY
Symbolic constant for process instance action set customer property.
  1. static
  2. int
SETVARIABLE
Symbolic constant for process instance action set variable.
  1. static
  2. int
SUSPEND
Symbolic constant for process instance action suspend.
  1. static
  2. int
TESTMIGRATION
Symbolic constant for test migration method which is used to test if a given instance can be migrated to the target template.
  1. static
  2. int
TRANSFERWORKITEM
Symbolic constant for process instance action transfer work item.
  1. static
  2. int
UNINITIALIZECORRELATIONSET
Symbolic constant for process instance action delete correlation set

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

FORCETERMINATE

  1. static final int FORCETERMINATE
Symbolic constant for process instance action force terminate.
See Also:

GETINPUTMESSAGE

  1. static final int GETINPUTMESSAGE
Symbolic constant for process instance action get input message.
See Also:

GETOUTPUTMESSAGE

  1. static final int GETOUTPUTMESSAGE
Symbolic constant for process instance action get output message.
See Also:

GETFAULTMESSAGE

  1. static final int GETFAULTMESSAGE
Symbolic constant for process instance action get fault message.
See Also:

GETVARIABLE

  1. static final int GETVARIABLE
Symbolic constant for process instance action get variable.
See Also:

GETCUSTOMATTRIBUTE

  1. static final int GETCUSTOMATTRIBUTE
Deprecated. Use GETCUSTOMPROPERTY.
Symbolic constant for process instance action get customer attribute.
See Also:

GETCUSTOMPROPERTY

  1. static final int GETCUSTOMPROPERTY
Symbolic constant for process instance action get customer property.
See Also:

SETCUSTOMATTRIBUTE

  1. static final int SETCUSTOMATTRIBUTE
Deprecated. Use SETCUSTOMPROPERTY.
Symbolic constant for process instance action set customer attribute.
See Also:

SETCUSTOMPROPERTY

  1. static final int SETCUSTOMPROPERTY
Symbolic constant for process instance action set customer property.
See Also:

DELETE

  1. static final int DELETE
Symbolic constant for process instance action delete.
See Also:

GETPROCESSINSTANCE

  1. static final int GETPROCESSINSTANCE
Symbolic constant for process instance action get process instance.
See Also:

GETUISETTINGS

  1. static final int GETUISETTINGS
Symbolic constant for process instance action get UI settings.
See Also:

SENDEVENT

  1. static final int SENDEVENT
Deprecated. As of version 7.5, no replacement.
Symbolic constant for process instance action send event.
See Also:

GETALLWORKITEMS

  1. static final int GETALLWORKITEMS
Symbolic constant for process instance action get all work items.
See Also:

GETALLACTIVITIES

  1. static final int GETALLACTIVITIES
Symbolic constant for process instance action get all activities.
See Also:

CREATEMESSAGE

  1. static final int CREATEMESSAGE
Symbolic constant for process instance action create message.
See Also:

CREATEWORKITEM

  1. static final int CREATEWORKITEM
Symbolic constant for process instance action create work item.
See Also:

DELETEWORKITEM

  1. static final int DELETEWORKITEM
Symbolic constant for process instance action delete work item.
See Also:

TRANSFERWORKITEM

  1. static final int TRANSFERWORKITEM
Symbolic constant for process instance action transfer work item.
See Also:

SETVARIABLE

  1. static final int SETVARIABLE
Symbolic constant for process instance action set variable.
See Also:

GETWORKITEMS

  1. static final int GETWORKITEMS
Symbolic constant for process instance action get workitems.
See Also:

FORCETERMINATEANDCOMPENSATE

  1. static final int FORCETERMINATEANDCOMPENSATE
Symbolic constant for process instance force terminate and compensate.
See Also:

SUSPEND

  1. static final int SUSPEND
Symbolic constant for process instance action suspend.
See Also:

RESUME

  1. static final int RESUME
Symbolic constant for process instance action resume.
See Also:

GETACTIVITYINSTANCE

  1. static final int GETACTIVITYINSTANCE
Symbolic constant for process instance action get avtivity instance.
See Also:

RESTART

  1. static final int RESTART
Symbolic constant for process instance action restart.
See Also:

GETACTIVEEVENTHANDLER

  1. static final int GETACTIVEEVENTHANDLER
Symbolic constant for process instance action get active event handlers.
See Also:

GETALLVARIABLENAMES

  1. static final int GETALLVARIABLENAMES
Symbolic constant for process instance action get all variable names.
See Also:

GETINITIALVARIABLEVALUE

  1. static final int GETINITIALVARIABLEVALUE
Symbolic constant for process instance action get initial variable value.
See Also:

CLAIMPROCESSOWNERSHIP

  1. static final int CLAIMPROCESSOWNERSHIP
Symbolic constant for process instance action claim process ownership
See Also:

GETCUSTOMPROPERTYNAMES

  1. static final int GETCUSTOMPROPERTYNAMES
Symbolic constant for process instance action get customer property names.
See Also:

GETCORRELATIONSETINSTANCES

  1. static final int GETCORRELATIONSETINSTANCES
Symbolic constant for process instance action get correlation set instances
See Also:

INITIALIZECORRELATIONSET

  1. static final int INITIALIZECORRELATIONSET
Symbolic constant for process instance action initialize correlation set
See Also:

UNINITIALIZECORRELATIONSET

  1. static final int UNINITIALIZECORRELATIONSET
Symbolic constant for process instance action delete correlation set
See Also:

MIGRATE

  1. static final int MIGRATE
Symbolic constant for process instance action migrate
See Also:

GETROLEINFO

  1. static final int GETROLEINFO
Symbolic constant for process instance action to retrieve role related information. States whether getUsersInRole() can be called.
Since:
7.0.0.2
See Also:

TESTMIGRATION

  1. static final int TESTMIGRATION
Symbolic constant for test migration method which is used to test if a given instance can be migrated to the target template.
See Also: