TaskHistoryEvent (IBM Business Process Manager, Release 8)

All Superinterfaces:

java.io.Serializable
```
public interface TaskHistoryEvent
extends java.io.Serializable
```
Accesses the properties of a task history event.
A task history event represents an event that occurrs during the lifetime of a task instance. Note that task history events are only written when writing these records is enabled.

Since:

7.5

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT`
`static int`	`EVENT_ESCALATION_CUSTOMPROPERTY_SET` States that a custom property is set for an escalation.
`static int`	`EVENT_ESCALATION_FIRED` States that an escalation is fired.
`static int`	`EVENT_ESCALATION_STARTED` States that an escalation is started.
`static int`	`EVENT_ESCALATION_UPDATED` States that an escalation is updated.
`static int`	`EVENT_ESCALATION_WORKITEM_CREATED` States that a work item is created for an escalation.
`static int`	`EVENT_ESCALATION_WORKITEM_DELETED` States that a work item is deleted for an escalation.
`static int`	`EVENT_ESCALATION_WORKITEM_REFRESHED` States that a work item is refreshed for an escalation.
`static int`	`EVENT_ESCALATION_WORKITEM_TRANSFERRED` States that a work item is transferred for an escalation.
`static int`	`EVENT_TASK_CLAIM_CANCELLED` States that the claim of the task is cancelled.
`static int`	`EVENT_TASK_CLAIMED` States that the task is claimed.
`static int`	`EVENT_TASK_COMPLETED` States that the task is completed.
`static int`	`EVENT_TASK_COMPLETED_WITH_FOLLOW_ON_TASK` States that the task completed and created follow-on tasks.
`static int`	`EVENT_TASK_CREATED` States that the task is created.
`static int`	`EVENT_TASK_CUSTOMPROPERTY_SET` States that a custom property is set on the task.
`static int`	`EVENT_TASK_DELETED` States that the task is deleted.
`static int`	`EVENT_TASK_EXPIRED` States that the task is expired.
`static int`	`EVENT_TASK_FAILED` States that the task is failed.
`static int`	`EVENT_TASK_FAULT_MESSAGE_UPDATED` States that a fault message of the task is updated.
`static int`	`EVENT_TASK_INPUT_MESSAGE_UPDATED` States that the input message of the task is updated.
`static int`	`EVENT_TASK_OUTPUT_MESSAGE_UPDATED` States that the output message of the task is updated.
`static int`	`EVENT_TASK_RESTARTED` States that the task is restarted.
`static int`	`EVENT_TASK_RESUMED` States that the task is resumed.
`static int`	`EVENT_TASK_STARTED` States that the task is started.
`static int`	`EVENT_TASK_SUBTASKS_COMPLETED` States that subtasks completed for the task.
`static int`	`EVENT_TASK_SUSPENDED` States that the task is suspended.
`static int`	`EVENT_TASK_TEMPLATE_INSTALLED` States that a task template is installed.
`static int`	`EVENT_TASK_TEMPLATE_UNINSTALLED` States that a task template is uninstalled.
`static int`	`EVENT_TASK_TERMINATED` States that the task is terminated.
`static int`	`EVENT_TASK_UPDATED` States that the task is updated.
`static int`	`EVENT_TASK_WAITING_FOR_SUBTASK` States that the task is waiting for subtasks to complete.
`static int`	`EVENT_TASK_WORKITEM_CREATED` States that a work item is created for the task.
`static int`	`EVENT_TASK_WORKITEM_DELETED` States that a work item is deleted for the task.
`static int`	`EVENT_TASK_WORKITEM_REFRESHED` States that a work item is refreshed for the task,
`static int`	`EVENT_TASK_WORKITEM_TRANSFERRED` States that a work item is transferred for the task.
`static int`	`REASON_ADMINISTRATOR` States that operations can be executed on the associated object that require administrator rights, for example, deletion of an object.
`static int`	`REASON_EDITOR` States that operations can be executed on the associated object that require editor authority, for example, setting the output message of an object.
`static int`	`REASON_ESCALATION_RECEIVER` States that operations can be executed on the associated object that require escalation receiver rights, for example, reading properties of an object that is escalated.
`static int`	`REASON_MAX` Do not use - internal only.
`static int`	`REASON_NONE` States that no reason is logged.
`static int`	`REASON_ORIGINATOR` States that operations can be executed on the associated object that require originator rights.
`static int`	`REASON_OWNER` States that the associated object can be completed.
`static int`	`REASON_POTENTIAL_INSTANCE_CREATOR` States that operations can be executed on the associated object that require instance creator rights, for example, creating objects.
`static int`	`REASON_POTENTIAL_OWNER` States that the associated object can be claimed.
`static int`	`REASON_POTENTIAL_SENDER` Do not use - internal only.
`static int`	`REASON_POTENTIAL_STARTER` States that operations can be executed on the associated object that require potential starter rights, for example, creating objects.
`static int`	`REASON_READER` States that operations can be executed on the associated object that require reader authority, for example, reading the properties of an object.
`static int`	`REASON_STARTER` States that operations can be executed on the associated object that require starter authority.
`static int`	`REASON_STATE_MACHINE_END` Do not use - internal only.
`static int`	`REASON_STATE_MACHINE_EVENT_AVAILABLE` Do not use - internal only.
`static int`	`REASON_STATE_MACHINE_START` Do not use - internal only.
`static int`	`WORK_ITEM_KIND_EVERYBODY` States that the work item is assigned to everybody.
`static int`	`WORK_ITEM_KIND_GROUP` States that the work item is assigned to one or more groups.
`static int`	`WORK_ITEM_KIND_USER` States that the work item is assigned to one or more users.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getAssignmentReason()` Returns the reason of work item data logged in this event.
`ESIID`	`getEscalationInstanceID()` Returns the object ID of an escalation instance if the event is associated with an escalation.
`java.util.Calendar`	`getEventTime()` Returns the time when the logged event occurred.
`int`	`getEventType()` Returns the type of the event.
`java.lang.String`	`getFromOwner()` Returns the name of the user or group whose work item is transferred to the to-owner, or whose work item is deleted.
`java.util.Calendar`	`getNextEventTime()` Returns the time when the next event is due to occur, if any.
`TKIID`	`getParentContextID()` Returns the object ID of a related task instance, if the task instance is a subtask or follow-on task of a parent task.
`java.lang.String`	`getPrincipal()` Returns the name of the principal who triggered the event.
`TKIID`	`getTaskInstanceID()` Returns the object ID of the associated task instance.
`java.lang.String`	`getToOwner()` Returns the name of the user or group for whom a work item is created, or transferred to.
`int`	`getWorkItemKind()` States the kind of work item authorization.

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    See Also:
    Constant Field Values
  - EVENT_TASK_WORKITEM_TRANSFERRED
```
static final int EVENT_TASK_WORKITEM_TRANSFERRED
```
    States that a work item is transferred for the task.
    
    See Also:
    Constant Field Values
  - EVENT_ESCALATION_WORKITEM_DELETED
```
static final int EVENT_ESCALATION_WORKITEM_DELETED
```
    States that a work item is deleted for an escalation.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_UPDATED
```
static final int EVENT_TASK_UPDATED
```
    States that the task is updated.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_COMPLETED_WITH_FOLLOW_ON_TASK
```
static final int EVENT_TASK_COMPLETED_WITH_FOLLOW_ON_TASK
```
    States that the task completed and created follow-on tasks.
    
    See Also:
    Constant Field Values
  - EVENT_ESCALATION_FIRED
```
static final int EVENT_ESCALATION_FIRED
```
    States that an escalation is fired.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_TEMPLATE_INSTALLED
```
static final int EVENT_TASK_TEMPLATE_INSTALLED
```
    States that a task template is installed.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_STARTED
```
static final int EVENT_TASK_STARTED
```
    States that the task is started.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_TEMPLATE_UNINSTALLED
```
static final int EVENT_TASK_TEMPLATE_UNINSTALLED
```
    States that a task template is uninstalled.
    
    See Also:
    Constant Field Values
  - EVENT_ESCALATION_WORKITEM_CREATED
```
static final int EVENT_ESCALATION_WORKITEM_CREATED
```
    States that a work item is created for an escalation.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_WORKITEM_DELETED
```
static final int EVENT_TASK_WORKITEM_DELETED
```
    States that a work item is deleted for the task.
    
    See Also:
    Constant Field Values
  - EVENT_ESCALATION_UPDATED
```
static final int EVENT_ESCALATION_UPDATED
```
    States that an escalation is updated.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_COMPLETED
```
static final int EVENT_TASK_COMPLETED
```
    States that the task is completed.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_TERMINATED
```
static final int EVENT_TASK_TERMINATED
```
    States that the task is terminated.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_INPUT_MESSAGE_UPDATED
```
static final int EVENT_TASK_INPUT_MESSAGE_UPDATED
```
    States that the input message of the task is updated.
    
    See Also:
    Constant Field Values
  - EVENT_ESCALATION_STARTED
```
static final int EVENT_ESCALATION_STARTED
```
    States that an escalation is started.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_RESUMED
```
static final int EVENT_TASK_RESUMED
```
    States that the task is resumed.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_WORKITEM_CREATED
```
static final int EVENT_TASK_WORKITEM_CREATED
```
    States that a work item is created for the task.
    
    See Also:
    Constant Field Values
  - EVENT_ESCALATION_WORKITEM_REFRESHED
```
static final int EVENT_ESCALATION_WORKITEM_REFRESHED
```
    States that a work item is refreshed for an escalation.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_DELETED
```
static final int EVENT_TASK_DELETED
```
    States that the task is deleted.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_SUSPENDED
```
static final int EVENT_TASK_SUSPENDED
```
    States that the task is suspended.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_CLAIMED
```
static final int EVENT_TASK_CLAIMED
```
    States that the task is claimed.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_WAITING_FOR_SUBTASK
```
static final int EVENT_TASK_WAITING_FOR_SUBTASK
```
    States that the task is waiting for subtasks to complete.
    
    See Also:
    Constant Field Values
  - EVENT_ESCALATION_CUSTOMPROPERTY_SET
```
static final int EVENT_ESCALATION_CUSTOMPROPERTY_SET
```
    States that a custom property is set for an escalation.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_SUBTASKS_COMPLETED
```
static final int EVENT_TASK_SUBTASKS_COMPLETED
```
    States that subtasks completed for the task.
    
    See Also:
    Constant Field Values
  - EVENT_ESCALATION_WORKITEM_TRANSFERRED
```
static final int EVENT_ESCALATION_WORKITEM_TRANSFERRED
```
    States that a work item is transferred for an escalation.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_EXPIRED
```
static final int EVENT_TASK_EXPIRED
```
    States that the task is expired.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_FAULT_MESSAGE_UPDATED
```
static final int EVENT_TASK_FAULT_MESSAGE_UPDATED
```
    States that a fault message of the task is updated.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_FAILED
```
static final int EVENT_TASK_FAILED
```
    States that the task is failed.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_CREATED
```
static final int EVENT_TASK_CREATED
```
    States that the task is created.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_WORKITEM_REFRESHED
```
static final int EVENT_TASK_WORKITEM_REFRESHED
```
    States that a work item is refreshed for the task,
    
    See Also:
    Constant Field Values
  - EVENT_TASK_RESTARTED
```
static final int EVENT_TASK_RESTARTED
```
    States that the task is restarted.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_CLAIM_CANCELLED
```
static final int EVENT_TASK_CLAIM_CANCELLED
```
    States that the claim of the task is cancelled.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_OUTPUT_MESSAGE_UPDATED
```
static final int EVENT_TASK_OUTPUT_MESSAGE_UPDATED
```
    States that the output message of the task is updated.
    
    See Also:
    Constant Field Values
  - EVENT_TASK_CUSTOMPROPERTY_SET
```
static final int EVENT_TASK_CUSTOMPROPERTY_SET
```
    States that a custom property is set on the task.
    
    See Also:
    Constant Field Values
  - REASON_STATE_MACHINE_START
```
static final int REASON_STATE_MACHINE_START
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - REASON_STATE_MACHINE_EVENT_AVAILABLE
```
static final int REASON_STATE_MACHINE_EVENT_AVAILABLE
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - REASON_EDITOR
```
static final int REASON_EDITOR
```
    States that operations can be executed on the associated object that require editor authority, for example, setting the output message of an object.
    
    See Also:
    Constant Field Values
  - REASON_MAX
```
static final int REASON_MAX
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - REASON_POTENTIAL_SENDER
```
static final int REASON_POTENTIAL_SENDER
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - REASON_ADMINISTRATOR
```
static final int REASON_ADMINISTRATOR
```
    States that operations can be executed on the associated object that require administrator rights, for example, deletion of an object.
    
    See Also:
    Constant Field Values
  - REASON_NONE
```
static final int REASON_NONE
```
    States that no reason is logged.
    
    See Also:
    Constant Field Values
  - REASON_POTENTIAL_STARTER
```
static final int REASON_POTENTIAL_STARTER
```
    States that operations can be executed on the associated object that require potential starter rights, for example, creating objects.
    
    See Also:
    Constant Field Values
  - REASON_STARTER
```
static final int REASON_STARTER
```
    States that operations can be executed on the associated object that require starter authority.
    
    See Also:
    Constant Field Values
  - REASON_POTENTIAL_OWNER
```
static final int REASON_POTENTIAL_OWNER
```
    States that the associated object can be claimed.
    
    See Also:
    Constant Field Values
  - REASON_ORIGINATOR
```
static final int REASON_ORIGINATOR
```
    States that operations can be executed on the associated object that require originator rights.
    
    See Also:
    Constant Field Values
  - REASON_OWNER
```
static final int REASON_OWNER
```
    States that the associated object can be completed.
    
    See Also:
    Constant Field Values
  - REASON_STATE_MACHINE_END
```
static final int REASON_STATE_MACHINE_END
```
    Do not use - internal only.
    
    See Also:
    Constant Field Values
  - REASON_READER
```
static final int REASON_READER
```
    States that operations can be executed on the associated object that require reader authority, for example, reading the properties of an object.
    
    See Also:
    Constant Field Values
  - REASON_ESCALATION_RECEIVER
```
static final int REASON_ESCALATION_RECEIVER
```
    States that operations can be executed on the associated object that require escalation receiver rights, for example, reading properties of an object that is escalated.
    
    See Also:
    Constant Field Values
  - REASON_POTENTIAL_INSTANCE_CREATOR
```
static final int REASON_POTENTIAL_INSTANCE_CREATOR
```
    States that operations can be executed on the associated object that require instance creator rights, for example, creating objects.
    
    See Also:
    Constant Field Values
  - WORK_ITEM_KIND_EVERYBODY
```
static final int WORK_ITEM_KIND_EVERYBODY
```
    States that the work item is assigned to everybody.
    
    See Also:
    Constant Field Values
  - WORK_ITEM_KIND_GROUP
```
static final int WORK_ITEM_KIND_GROUP
```
    States that the work item is assigned to one or more groups.
    
    See Also:
    Constant Field Values
  - WORK_ITEM_KIND_USER
```
static final int WORK_ITEM_KIND_USER
```
    States that the work item is assigned to one or more users.
    
    See Also:
    Constant Field Values
- Method Detail
  - getTaskInstanceID
```
TKIID getTaskInstanceID()
```
    Returns the object ID of the associated task instance.
  - getEscalationInstanceID
```
ESIID getEscalationInstanceID()
```
    Returns the object ID of an escalation instance if the event is associated with an escalation. Otherwise, returns null.
  - getParentContextID
```
TKIID getParentContextID()
```
    Returns the object ID of a related task instance, if the task instance is a subtask or follow-on task of a parent task. Otherwise, returns null.
  - getEventType
```
int getEventType()
```
    Returns the type of the event. See EVENT_TASK_CREATED etc.
  - getEventTime
```
java.util.Calendar getEventTime()
```
    Returns the time when the logged event occurred.
  - getNextEventTime
```
java.util.Calendar getNextEventTime()
```
    Returns the time when the next event is due to occur, if any. The time depends on the event type.
    EVENT_TASK_STARTED, the expiration time of the task instance.
    EVENT_TASK_SUSPENDED, the resumption time of the task instance.
    EVENT_TASK_COMPLETED, EVENT_TASK_TERMINATED, EVENT_TASK_EPIRED, and EVENT_TASK_FAILED, the time when the task instance is deleted automatically.
    EVENT_ESCALATION_STARTED, the time when the escalation fires.
    EVENT_ESCALATION_FIRED, the time when the escalation fires again.
  - getPrincipal
```
java.lang.String getPrincipal()
```
    Returns the name of the principal who triggered the event.
  - getAssignmentReason
```
int getAssignmentReason()
```
    Returns the reason of work item data logged in this event. Returns REASON_NONE if no reason is logged.
  - getWorkItemKind
```
int getWorkItemKind()
```
    States the kind of work item authorization.
    Possible authorization kinds are WORK_ITEM_KIND_EVERYBODY, WORK_ITEM_KIND_USER, WORK_ITEM_KIND_GROUP.
  - getFromOwner
```
java.lang.String getFromOwner()
```
    Returns the name of the user or group whose work item is transferred to the to-owner, or whose work item is deleted. Returns null when no work item is deleted or transferred.
  - getToOwner
```
java.lang.String getToOwner()
```
    Returns the name of the user or group for whom a work item is created, or transferred to. Returns null when no work item is created or transferred.

COPYRIGHT

EVENT_TASK_WORKITEM_TRANSFERRED

EVENT_ESCALATION_WORKITEM_DELETED

EVENT_TASK_UPDATED

EVENT_TASK_COMPLETED_WITH_FOLLOW_ON_TASK

EVENT_ESCALATION_FIRED

EVENT_TASK_TEMPLATE_INSTALLED

EVENT_TASK_STARTED

EVENT_TASK_TEMPLATE_UNINSTALLED

EVENT_ESCALATION_WORKITEM_CREATED

EVENT_TASK_WORKITEM_DELETED

EVENT_ESCALATION_UPDATED

EVENT_TASK_COMPLETED

EVENT_TASK_TERMINATED

EVENT_TASK_INPUT_MESSAGE_UPDATED

EVENT_ESCALATION_STARTED

EVENT_TASK_RESUMED

EVENT_TASK_WORKITEM_CREATED

EVENT_ESCALATION_WORKITEM_REFRESHED

EVENT_TASK_DELETED

EVENT_TASK_SUSPENDED

EVENT_TASK_CLAIMED

EVENT_TASK_WAITING_FOR_SUBTASK

EVENT_ESCALATION_CUSTOMPROPERTY_SET

EVENT_TASK_SUBTASKS_COMPLETED

EVENT_ESCALATION_WORKITEM_TRANSFERRED

EVENT_TASK_EXPIRED

EVENT_TASK_FAULT_MESSAGE_UPDATED

EVENT_TASK_FAILED

EVENT_TASK_CREATED

EVENT_TASK_WORKITEM_REFRESHED

EVENT_TASK_RESTARTED

EVENT_TASK_CLAIM_CANCELLED

EVENT_TASK_OUTPUT_MESSAGE_UPDATED

EVENT_TASK_CUSTOMPROPERTY_SET

REASON_STATE_MACHINE_START

REASON_STATE_MACHINE_EVENT_AVAILABLE

REASON_EDITOR

REASON_MAX

REASON_POTENTIAL_SENDER

REASON_ADMINISTRATOR

REASON_NONE

REASON_POTENTIAL_STARTER

REASON_STARTER

REASON_POTENTIAL_OWNER

REASON_ORIGINATOR

REASON_OWNER

REASON_STATE_MACHINE_END

REASON_READER

REASON_ESCALATION_RECEIVER

REASON_POTENTIAL_INSTANCE_CREATOR

WORK_ITEM_KIND_EVERYBODY

WORK_ITEM_KIND_GROUP

WORK_ITEM_KIND_USER

getTaskInstanceID

getEscalationInstanceID

getParentContextID

getEventType

getEventTime

getNextEventTime

getPrincipal

getAssignmentReason

getWorkItemKind

getFromOwner

getToOwner