com.ibm.bpe.api
Interface ProcessInstanceActions


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.


Field Summary
static int CREATEMESSAGE
          Symbolic constant for process instance action create message.
static int CREATEWORKITEM
          Symbolic constant for process instance action create work item.
static int DELETE
          Symbolic constant for process instance action delete.
static int DELETEWORKITEM
          Symbolic constant for process instance action delete work item.
static int FORCETERMINATE
          Symbolic constant for process instance action force terminate.
static int FORCETERMINATEANDCOMPENSATE
          Symbolic constant for process instance force terminate and compensate.
static int GETALLACTIVITIES
          Symbolic constant for process instance action get all activities.
static int GETALLWORKITEMS
          Symbolic constant for process instance action get all work items.
static int GETCUSTOMATTRIBUTE
          Deprecated. Use GETCUSTOMPROPERTY.
static int GETCUSTOMPROPERTY
          Symbolic constant for process instance action get customer property.
static int GETFAULTMESSAGE
          Symbolic constant for process instance action get fault message.
static int GETINPUTMESSAGE
          Symbolic constant for process instance action get input message.
static int GETOUTPUTMESSAGE
          Symbolic constant for process instance action get output message.
static int GETPROCESSINSTANCE
          Symbolic constant for process instance action get process instance.
static int GETUISETTINGS
          Symbolic constant for process instance action get UI settings.
static int GETVARIABLE
          Symbolic constant for process instance action get variable.
static int GETWORKITEMS
          Symbolic constant for process instance action get workitems.
static int SENDEVENT
          Symbolic constant for process instance action send event.
static int SETCUSTOMATTRIBUTE
          Deprecated. Use SETCUSTOMPROPERTY.
static int SETCUSTOMPROPERTY
          Symbolic constant for process instance action set customer property.
static int SETVARIABLE
          Symbolic constant for process instance action set variable.
static int TRANSFERWORKITEM
          Symbolic constant for process instance action transfer work item.
 

Field Detail

FORCETERMINATE

public static final int FORCETERMINATE
Symbolic constant for process instance action force terminate.

See Also:
Constant Field Values

GETINPUTMESSAGE

public static final int GETINPUTMESSAGE
Symbolic constant for process instance action get input message.

See Also:
Constant Field Values

GETOUTPUTMESSAGE

public static final int GETOUTPUTMESSAGE
Symbolic constant for process instance action get output message.

See Also:
Constant Field Values

GETFAULTMESSAGE

public static final int GETFAULTMESSAGE
Symbolic constant for process instance action get fault message.

See Also:
Constant Field Values

GETVARIABLE

public static final int GETVARIABLE
Symbolic constant for process instance action get variable.

See Also:
Constant Field Values

GETCUSTOMATTRIBUTE

public static final int GETCUSTOMATTRIBUTE
Deprecated. Use GETCUSTOMPROPERTY.

Symbolic constant for process instance action get customer attribute.

See Also:
Constant Field Values

GETCUSTOMPROPERTY

public static final int GETCUSTOMPROPERTY
Symbolic constant for process instance action get customer property.

See Also:
Constant Field Values

SETCUSTOMATTRIBUTE

public static final int SETCUSTOMATTRIBUTE
Deprecated. Use SETCUSTOMPROPERTY.

Symbolic constant for process instance action set customer attribute.

See Also:
Constant Field Values

SETCUSTOMPROPERTY

public static final int SETCUSTOMPROPERTY
Symbolic constant for process instance action set customer property.

See Also:
Constant Field Values

DELETE

public static final int DELETE
Symbolic constant for process instance action delete.

See Also:
Constant Field Values

GETPROCESSINSTANCE

public static final int GETPROCESSINSTANCE
Symbolic constant for process instance action get process instance.

See Also:
Constant Field Values

GETUISETTINGS

public static final int GETUISETTINGS
Symbolic constant for process instance action get UI settings.

See Also:
Constant Field Values

SENDEVENT

public static final int SENDEVENT
Symbolic constant for process instance action send event.

See Also:
Constant Field Values

GETALLWORKITEMS

public static final int GETALLWORKITEMS
Symbolic constant for process instance action get all work items.

See Also:
Constant Field Values

GETALLACTIVITIES

public static final int GETALLACTIVITIES
Symbolic constant for process instance action get all activities.

See Also:
Constant Field Values

CREATEMESSAGE

public static final int CREATEMESSAGE
Symbolic constant for process instance action create message.

See Also:
Constant Field Values

CREATEWORKITEM

public static final int CREATEWORKITEM
Symbolic constant for process instance action create work item.

See Also:
Constant Field Values

DELETEWORKITEM

public static final int DELETEWORKITEM
Symbolic constant for process instance action delete work item.

See Also:
Constant Field Values

TRANSFERWORKITEM

public static final int TRANSFERWORKITEM
Symbolic constant for process instance action transfer work item.

See Also:
Constant Field Values

SETVARIABLE

public static final int SETVARIABLE
Symbolic constant for process instance action set variable.

See Also:
Constant Field Values

GETWORKITEMS

public static final int GETWORKITEMS
Symbolic constant for process instance action get workitems.

See Also:
Constant Field Values

FORCETERMINATEANDCOMPENSATE

public static final int FORCETERMINATEANDCOMPENSATE
Symbolic constant for process instance force terminate and compensate.

See Also:
Constant Field Values