com.ibm.bpe.api

Interface InitiateAndClaimFirstResult

All Superinterfaces:
java.io.Serializable

  1. public interface InitiateAndClaimFirstResult
  2. extends java.io.Serializable
Returns the result of an initiateAndClaimFirst() call. Returns the object ID of the process instance created and information about the claimed activity instance.

Since:
6.2

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getActivityName()
Returns the name of the activity that has been claimed.
  1. AIID
getAIID()
Returns the object identifier of the activity that has been claimed.
  1. ATID
getATID()
Returns the object identifier of the activity template that is associated to the claimed activity.
  1. ClientObjectWrapper
getInputMessage()
Returns the input message of the claimed activity.
  1. PIID
getPIID()
Returns the object identifier of the process instance that has been created.

Field Detail

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

Method Detail

getPIID

  1. PIID getPIID()
Returns the object identifier of the process instance that has been created.

getAIID

  1. AIID getAIID()
Returns the object identifier of the activity that has been claimed. If no activity has been claimed, null is returned.

getATID

  1. ATID getATID()
Returns the object identifier of the activity template that is associated to the claimed activity. This object identifier may be used for correlating information in the client. If no activity has been claimed, null is returned.

getActivityName

  1. java.lang.String getActivityName( )
Returns the name of the activity that has been claimed. Returns null if no activity has been claimed or if there is no name.

getInputMessage

  1. ClientObjectWrapper getInputMessage( )
Returns the input message of the claimed activity. Returns null if no activity has been claimed or if there is no input message.