ClaimResult (IBM Business Process Manager, Release 8)

Skip navigation links

IBM Business Process Manager^TM
Release 8

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

java.io.Serializable
```
public interface ClaimResult
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

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT_

Method Summary

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

- Field Detail
  - COPYRIGHT_
```
static final java.lang.String COPYRIGHT_
```
    See Also:
    Constant Field Values
- Method Detail
  - getTKIID
```
TKIID getTKIID()
```
    Returns the object identifier of the task instance that has been processed.
  - getInputMessage
```
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
```
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.