com.ibm.task.api

Interface ClaimResult

All Superinterfaces:
java.io.Serializable

  1. public interface ClaimResult
  2. extends java.io.Serializable
Returns the result of a special claim request. The claim request either asks to process multiple task instances at a time or uses a query table to determine the task to be claimed.
Since:
6.1

Field Summary

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

Method Summary

Modifier and Type Method and Description
  1. ClientObjectWrapper
getInputMessage()
Returns the input message of the claimed task.
  1. TaskException
getTaskException()
Returns the TaskException object that describes any error that occurred during processing.
  1. TKIID
getTKIID()
Returns the object identifier of the task instance that has been processed.

Field Detail

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

Method Detail

getTKIID

  1. TKIID getTKIID()
Returns the object identifier of the task instance that has been processed.

getInputMessage

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

getTaskException

  1. TaskException getTaskException( )
Returns the TaskException object that describes any error that occurred during processing. Returns null if processing completed successfully.

If the claim request refers to a query table, a ClaimResult is only returned when a task instance is successfully claimed. This means that getTaskException() always returns null.