com.ibm.task.api
Interface TaskHistoryEvent
All Superinterfaces:
java.io.Serializable
- public interface TaskHistoryEvent
- extends java.io.Serializable
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 |
---|---|
|
COPYRIGHT
|
|
EVENT_ESCALATION_CUSTOMPROPERTY_SET
States that a custom property is set for an escalation.
|
|
EVENT_ESCALATION_FIRED
States that an escalation is fired.
|
|
EVENT_ESCALATION_STARTED
States that an escalation is started.
|
|
EVENT_ESCALATION_UPDATED
States that an escalation is updated.
|
|
EVENT_ESCALATION_WORKITEM_CREATED
States that a work item is created for an escalation.
|
|
EVENT_ESCALATION_WORKITEM_DELETED
States that a work item is deleted for an escalation.
|
|
EVENT_ESCALATION_WORKITEM_REFRESHED
States that a work item is refreshed for an escalation.
|
|
EVENT_ESCALATION_WORKITEM_TRANSFERRED
States that a work item is transferred for an escalation.
|
|
EVENT_TASK_CLAIM_CANCELLED
States that the claim of the task is cancelled.
|
|
EVENT_TASK_CLAIMED
States that the task is claimed.
|
|
EVENT_TASK_COMPLETED
States that the task is completed.
|
|
EVENT_TASK_COMPLETED_WITH_FOLLOW_ON_TASK
States that the task completed and created follow-on tasks.
|
|
EVENT_TASK_CREATED
States that the task is created.
|
|
EVENT_TASK_CUSTOMPROPERTY_SET
States that a custom property is set on the task.
|
|
EVENT_TASK_DELETED
States that the task is deleted.
|
|
EVENT_TASK_EXPIRED
States that the task is expired.
|
|
EVENT_TASK_FAILED
States that the task is failed.
|
|
EVENT_TASK_FAULT_MESSAGE_UPDATED
States that a fault message of the task is updated.
|
|
EVENT_TASK_INPUT_MESSAGE_UPDATED
States that the input message of the task is updated.
|
|
EVENT_TASK_OUTPUT_MESSAGE_UPDATED
States that the output message of the task is updated.
|
|
EVENT_TASK_RESTARTED
States that the task is restarted.
|
|
EVENT_TASK_RESUMED
States that the task is resumed.
|
|
EVENT_TASK_STARTED
States that the task is started.
|
|
EVENT_TASK_SUBTASKS_COMPLETED
States that subtasks completed for the task.
|
|
EVENT_TASK_SUSPENDED
States that the task is suspended.
|
|
EVENT_TASK_TEMPLATE_INSTALLED
States that a task template is installed.
|
|
EVENT_TASK_TEMPLATE_UNINSTALLED
States that a task template is uninstalled.
|
|
EVENT_TASK_TERMINATED
States that the task is terminated.
|
|
EVENT_TASK_UPDATED
States that the task is updated.
|
|
EVENT_TASK_WAITING_FOR_SUBTASK
States that the task is waiting for subtasks to complete.
|
|
EVENT_TASK_WORKITEM_CREATED
States that a work item is created for the task.
|
|
EVENT_TASK_WORKITEM_DELETED
States that a work item is deleted for the task.
|
|
EVENT_TASK_WORKITEM_REFRESHED
States that a work item is refreshed for the task,
|
|
EVENT_TASK_WORKITEM_TRANSFERRED
States that a work item is transferred for the task.
|
|
REASON_ADMINISTRATOR
States that operations can be executed on the associated object that require
administrator rights, for example, deletion of an object.
|
|
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.
|
|
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.
|
|
REASON_MAX
Do not use - internal only.
|
|
REASON_NONE
States that no reason is logged.
|
|
REASON_ORIGINATOR
States that operations can be executed on the associated object that require
originator rights.
|
|
REASON_OWNER
States that the associated object can be completed.
|
|
REASON_POTENTIAL_INSTANCE_CREATOR
States that operations can be executed on the associated object that require
instance creator rights, for example, creating objects.
|
|
REASON_POTENTIAL_OWNER
States that the associated object can be claimed.
|
|
REASON_POTENTIAL_SENDER
Do not use - internal only.
|
|
REASON_POTENTIAL_STARTER
States that operations can be executed on the associated object that require
potential starter rights, for example, creating objects.
|
|
REASON_READER
States that operations can be executed on the associated object that require
reader authority, for example, reading the properties of an object.
|
|
REASON_STARTER
States that operations can be executed on the associated object that require
starter authority.
|
|
REASON_STATE_MACHINE_END
Do not use - internal only.
|
|
REASON_STATE_MACHINE_EVENT_AVAILABLE
Do not use - internal only.
|
|
REASON_STATE_MACHINE_START
Do not use - internal only.
|
|
WORK_ITEM_KIND_EVERYBODY
States that the work item is assigned to everybody.
|
|
WORK_ITEM_KIND_GROUP
States that the work item is assigned to one or more groups.
|
|
WORK_ITEM_KIND_USER
States that the work item is assigned to one or more users.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getAssignmentReason()
Returns the reason of work item data logged in this event.
|
getEscalationInstanceID()
Returns the object ID of an escalation instance if the event is associated with
an escalation.
|
|
|
getEventTime()
Returns the time when the logged event occurred.
|
|
getEventType()
Returns the type of the event.
|
|
getFromOwner()
Returns the name of the user or group whose work item is transferred to the to-owner,
or whose work item is deleted.
|
|
getNextEventTime()
Returns the time when the next event is due to occur, if any.
|
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.
|
|
|
getPrincipal()
Returns the name of the principal who triggered the event.
|
getTaskInstanceID()
Returns the object ID of the associated task instance.
|
|
|
getToOwner()
Returns the name of the user or group for whom a work item is created, or transferred to.
|
|
getWorkItemKind()
States the kind of work item authorization.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
EVENT_TASK_WORKITEM_TRANSFERRED
- static final int EVENT_TASK_WORKITEM_TRANSFERRED
States that a work item is transferred for the task.
See Also:
EVENT_ESCALATION_WORKITEM_DELETED
- static final int EVENT_ESCALATION_WORKITEM_DELETED
States that a work item is deleted for an escalation.
See Also:
EVENT_TASK_UPDATED
- static final int EVENT_TASK_UPDATED
States that the task is updated.
See Also:
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:
EVENT_ESCALATION_FIRED
- static final int EVENT_ESCALATION_FIRED
States that an escalation is fired.
See Also:
EVENT_TASK_TEMPLATE_INSTALLED
- static final int EVENT_TASK_TEMPLATE_INSTALLED
States that a task template is installed.
See Also:
EVENT_TASK_STARTED
- static final int EVENT_TASK_STARTED
States that the task is started.
See Also:
EVENT_TASK_TEMPLATE_UNINSTALLED
- static final int EVENT_TASK_TEMPLATE_UNINSTALLED
States that a task template is uninstalled.
See Also:
EVENT_ESCALATION_WORKITEM_CREATED
- static final int EVENT_ESCALATION_WORKITEM_CREATED
States that a work item is created for an escalation.
See Also:
EVENT_TASK_WORKITEM_DELETED
- static final int EVENT_TASK_WORKITEM_DELETED
States that a work item is deleted for the task.
See Also:
EVENT_ESCALATION_UPDATED
- static final int EVENT_ESCALATION_UPDATED
States that an escalation is updated.
See Also:
EVENT_TASK_COMPLETED
- static final int EVENT_TASK_COMPLETED
States that the task is completed.
See Also:
EVENT_TASK_TERMINATED
- static final int EVENT_TASK_TERMINATED
States that the task is terminated.
See Also:
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:
EVENT_ESCALATION_STARTED
- static final int EVENT_ESCALATION_STARTED
States that an escalation is started.
See Also:
EVENT_TASK_RESUMED
- static final int EVENT_TASK_RESUMED
States that the task is resumed.
See Also:
EVENT_TASK_WORKITEM_CREATED
- static final int EVENT_TASK_WORKITEM_CREATED
States that a work item is created for the task.
See Also:
EVENT_ESCALATION_WORKITEM_REFRESHED
- static final int EVENT_ESCALATION_WORKITEM_REFRESHED
States that a work item is refreshed for an escalation.
See Also:
EVENT_TASK_DELETED
- static final int EVENT_TASK_DELETED
States that the task is deleted.
See Also:
EVENT_TASK_SUSPENDED
- static final int EVENT_TASK_SUSPENDED
States that the task is suspended.
See Also:
EVENT_TASK_CLAIMED
- static final int EVENT_TASK_CLAIMED
States that the task is claimed.
See Also:
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:
EVENT_ESCALATION_CUSTOMPROPERTY_SET
- static final int EVENT_ESCALATION_CUSTOMPROPERTY_SET
States that a custom property is set for an escalation.
See Also:
EVENT_TASK_SUBTASKS_COMPLETED
- static final int EVENT_TASK_SUBTASKS_COMPLETED
States that subtasks completed for the task.
See Also:
EVENT_ESCALATION_WORKITEM_TRANSFERRED
- static final int EVENT_ESCALATION_WORKITEM_TRANSFERRED
States that a work item is transferred for an escalation.
See Also:
EVENT_TASK_EXPIRED
- static final int EVENT_TASK_EXPIRED
States that the task is expired.
See Also:
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:
EVENT_TASK_FAILED
- static final int EVENT_TASK_FAILED
States that the task is failed.
See Also:
EVENT_TASK_CREATED
- static final int EVENT_TASK_CREATED
States that the task is created.
See Also:
EVENT_TASK_WORKITEM_REFRESHED
- static final int EVENT_TASK_WORKITEM_REFRESHED
States that a work item is refreshed for the task,
See Also:
EVENT_TASK_RESTARTED
- static final int EVENT_TASK_RESTARTED
States that the task is restarted.
See Also:
EVENT_TASK_CLAIM_CANCELLED
- static final int EVENT_TASK_CLAIM_CANCELLED
States that the claim of the task is cancelled.
See Also:
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:
EVENT_TASK_CUSTOMPROPERTY_SET
- static final int EVENT_TASK_CUSTOMPROPERTY_SET
States that a custom property is set on the task.
See Also:
REASON_STATE_MACHINE_START
- static final int REASON_STATE_MACHINE_START
Do not use - internal only.
See Also:
REASON_STATE_MACHINE_EVENT_AVAILABLE
- static final int REASON_STATE_MACHINE_EVENT_AVAILABLE
Do not use - internal only.
See Also:
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:
REASON_MAX
- static final int REASON_MAX
Do not use - internal only.
See Also:
REASON_POTENTIAL_SENDER
- static final int REASON_POTENTIAL_SENDER
Do not use - internal only.
See Also:
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:
REASON_NONE
- static final int REASON_NONE
States that no reason is logged.
See Also:
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:
REASON_STARTER
- static final int REASON_STARTER
States that operations can be executed on the associated object that require
starter authority.
See Also:
REASON_POTENTIAL_OWNER
- static final int REASON_POTENTIAL_OWNER
States that the associated object can be claimed.
See Also:
REASON_ORIGINATOR
- static final int REASON_ORIGINATOR
States that operations can be executed on the associated object that require
originator rights.
See Also:
REASON_OWNER
- static final int REASON_OWNER
States that the associated object can be completed.
See Also:
REASON_STATE_MACHINE_END
- static final int REASON_STATE_MACHINE_END
Do not use - internal only.
See Also:
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:
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:
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:
WORK_ITEM_KIND_EVERYBODY
- static final int WORK_ITEM_KIND_EVERYBODY
States that the work item is assigned to everybody.
See Also:
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:
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:
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.