com.ibm.task.api

Interface TaskHistoryEvent

All Superinterfaces:
java.io.Serializable

  1. public interface TaskHistoryEvent
  2. 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

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

Method Summary

Modifier and Type Method and Description
  1. int
getAssignmentReason()
Returns the reason of work item data logged in this event.
  1. ESIID
getEscalationInstanceID()
Returns the object ID of an escalation instance if the event is associated with an escalation.
  1. java.util.Calendar
getEventTime()
Returns the time when the logged event occurred.
  1. int
getEventType()
Returns the type of the event.
  1. 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.
  1. java.util.Calendar
getNextEventTime()
Returns the time when the next event is due to occur, if any.
  1. 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.
  1. java.lang.String
getPrincipal()
Returns the name of the principal who triggered the event.
  1. TKIID
getTaskInstanceID()
Returns the object ID of the associated task instance.
  1. java.lang.String
getToOwner()
Returns the name of the user or group for whom a work item is created, or transferred to.
  1. int
getWorkItemKind()
States the kind of work item authorization.

Field Detail

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

EVENT_TASK_WORKITEM_TRANSFERRED

  1. static final int EVENT_TASK_WORKITEM_TRANSFERRED
States that a work item is transferred for the task.
See Also:

EVENT_ESCALATION_WORKITEM_DELETED

  1. static final int EVENT_ESCALATION_WORKITEM_DELETED
States that a work item is deleted for an escalation.
See Also:

EVENT_TASK_UPDATED

  1. static final int EVENT_TASK_UPDATED
States that the task is updated.
See Also:

EVENT_TASK_COMPLETED_WITH_FOLLOW_ON_TASK

  1. static final int EVENT_TASK_COMPLETED_WITH_FOLLOW_ON_TASK
States that the task completed and created follow-on tasks.
See Also:

EVENT_ESCALATION_FIRED

  1. static final int EVENT_ESCALATION_FIRED
States that an escalation is fired.
See Also:

EVENT_TASK_TEMPLATE_INSTALLED

  1. static final int EVENT_TASK_TEMPLATE_INSTALLED
States that a task template is installed.
See Also:

EVENT_TASK_STARTED

  1. static final int EVENT_TASK_STARTED
States that the task is started.
See Also:

EVENT_TASK_TEMPLATE_UNINSTALLED

  1. static final int EVENT_TASK_TEMPLATE_UNINSTALLED
States that a task template is uninstalled.
See Also:

EVENT_ESCALATION_WORKITEM_CREATED

  1. static final int EVENT_ESCALATION_WORKITEM_CREATED
States that a work item is created for an escalation.
See Also:

EVENT_TASK_WORKITEM_DELETED

  1. static final int EVENT_TASK_WORKITEM_DELETED
States that a work item is deleted for the task.
See Also:

EVENT_ESCALATION_UPDATED

  1. static final int EVENT_ESCALATION_UPDATED
States that an escalation is updated.
See Also:

EVENT_TASK_COMPLETED

  1. static final int EVENT_TASK_COMPLETED
States that the task is completed.
See Also:

EVENT_TASK_TERMINATED

  1. static final int EVENT_TASK_TERMINATED
States that the task is terminated.
See Also:

EVENT_TASK_INPUT_MESSAGE_UPDATED

  1. static final int EVENT_TASK_INPUT_MESSAGE_UPDATED
States that the input message of the task is updated.
See Also:

EVENT_ESCALATION_STARTED

  1. static final int EVENT_ESCALATION_STARTED
States that an escalation is started.
See Also:

EVENT_TASK_RESUMED

  1. static final int EVENT_TASK_RESUMED
States that the task is resumed.
See Also:

EVENT_TASK_WORKITEM_CREATED

  1. static final int EVENT_TASK_WORKITEM_CREATED
States that a work item is created for the task.
See Also:

EVENT_ESCALATION_WORKITEM_REFRESHED

  1. static final int EVENT_ESCALATION_WORKITEM_REFRESHED
States that a work item is refreshed for an escalation.
See Also:

EVENT_TASK_DELETED

  1. static final int EVENT_TASK_DELETED
States that the task is deleted.
See Also:

EVENT_TASK_SUSPENDED

  1. static final int EVENT_TASK_SUSPENDED
States that the task is suspended.
See Also:

EVENT_TASK_CLAIMED

  1. static final int EVENT_TASK_CLAIMED
States that the task is claimed.
See Also:

EVENT_TASK_WAITING_FOR_SUBTASK

  1. static final int EVENT_TASK_WAITING_FOR_SUBTASK
States that the task is waiting for subtasks to complete.
See Also:

EVENT_ESCALATION_CUSTOMPROPERTY_SET

  1. static final int EVENT_ESCALATION_CUSTOMPROPERTY_SET
States that a custom property is set for an escalation.
See Also:

EVENT_TASK_SUBTASKS_COMPLETED

  1. static final int EVENT_TASK_SUBTASKS_COMPLETED
States that subtasks completed for the task.
See Also:

EVENT_ESCALATION_WORKITEM_TRANSFERRED

  1. static final int EVENT_ESCALATION_WORKITEM_TRANSFERRED
States that a work item is transferred for an escalation.
See Also:

EVENT_TASK_EXPIRED

  1. static final int EVENT_TASK_EXPIRED
States that the task is expired.
See Also:

EVENT_TASK_FAULT_MESSAGE_UPDATED

  1. static final int EVENT_TASK_FAULT_MESSAGE_UPDATED
States that a fault message of the task is updated.
See Also:

EVENT_TASK_FAILED

  1. static final int EVENT_TASK_FAILED
States that the task is failed.
See Also:

EVENT_TASK_CREATED

  1. static final int EVENT_TASK_CREATED
States that the task is created.
See Also:

EVENT_TASK_WORKITEM_REFRESHED

  1. static final int EVENT_TASK_WORKITEM_REFRESHED
States that a work item is refreshed for the task,
See Also:

EVENT_TASK_RESTARTED

  1. static final int EVENT_TASK_RESTARTED
States that the task is restarted.
See Also:

EVENT_TASK_CLAIM_CANCELLED

  1. static final int EVENT_TASK_CLAIM_CANCELLED
States that the claim of the task is cancelled.
See Also:

EVENT_TASK_OUTPUT_MESSAGE_UPDATED

  1. static final int EVENT_TASK_OUTPUT_MESSAGE_UPDATED
States that the output message of the task is updated.
See Also:

EVENT_TASK_CUSTOMPROPERTY_SET

  1. static final int EVENT_TASK_CUSTOMPROPERTY_SET
States that a custom property is set on the task.
See Also:

REASON_STATE_MACHINE_START

  1. static final int REASON_STATE_MACHINE_START
Do not use - internal only.
See Also:

REASON_STATE_MACHINE_EVENT_AVAILABLE

  1. static final int REASON_STATE_MACHINE_EVENT_AVAILABLE
Do not use - internal only.
See Also:

REASON_EDITOR

  1. 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:

REASON_MAX

  1. static final int REASON_MAX
Do not use - internal only.
See Also:

REASON_POTENTIAL_SENDER

  1. static final int REASON_POTENTIAL_SENDER
Do not use - internal only.
See Also:

REASON_ADMINISTRATOR

  1. 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:

REASON_NONE

  1. static final int REASON_NONE
States that no reason is logged.
See Also:

REASON_POTENTIAL_STARTER

  1. 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:

REASON_STARTER

  1. static final int REASON_STARTER
States that operations can be executed on the associated object that require starter authority.
See Also:

REASON_POTENTIAL_OWNER

  1. static final int REASON_POTENTIAL_OWNER
States that the associated object can be claimed.
See Also:

REASON_ORIGINATOR

  1. static final int REASON_ORIGINATOR
States that operations can be executed on the associated object that require originator rights.
See Also:

REASON_OWNER

  1. static final int REASON_OWNER
States that the associated object can be completed.
See Also:

REASON_STATE_MACHINE_END

  1. static final int REASON_STATE_MACHINE_END
Do not use - internal only.
See Also:

REASON_READER

  1. 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:

REASON_ESCALATION_RECEIVER

  1. 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:

REASON_POTENTIAL_INSTANCE_CREATOR

  1. 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:

WORK_ITEM_KIND_EVERYBODY

  1. static final int WORK_ITEM_KIND_EVERYBODY
States that the work item is assigned to everybody.
See Also:

WORK_ITEM_KIND_GROUP

  1. static final int WORK_ITEM_KIND_GROUP
States that the work item is assigned to one or more groups.
See Also:

WORK_ITEM_KIND_USER

  1. static final int WORK_ITEM_KIND_USER
States that the work item is assigned to one or more users.
See Also:

Method Detail

getTaskInstanceID

  1. TKIID getTaskInstanceID()
Returns the object ID of the associated task instance.

getEscalationInstanceID

  1. ESIID getEscalationInstanceID()
Returns the object ID of an escalation instance if the event is associated with an escalation. Otherwise, returns null.

getParentContextID

  1. 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

  1. int getEventType()
Returns the type of the event. See EVENT_TASK_CREATED etc.

getEventTime

  1. java.util.Calendar getEventTime( )
Returns the time when the logged event occurred.

getNextEventTime

  1. 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

  1. java.lang.String getPrincipal()
Returns the name of the principal who triggered the event.

getAssignmentReason

  1. int getAssignmentReason()
Returns the reason of work item data logged in this event. Returns REASON_NONE if no reason is logged.

getWorkItemKind

  1. 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

  1. 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

  1. 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.