|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Task
Accesses the properties of a task instance.
A task represents a piece of work. It contains all data that is necessary to get the job done. For example, a task that is associated to a group of potential owners allows a person that belongs to the group to claim the task, work on the task, and to complete the task.
Field Summary | |
---|---|
static int |
AUTH_NONE
States that no operations can be executed on the associated context. |
static int |
AUTH_READER
States that operations can be executed on the associated context object that require Reader authority, for example, reading the properties of a process instance. |
static int |
AUTO_DELETE_ON_COMPLETION
States that a completed task instance is deleted when the duration until deletion has passed. |
static int |
AUTO_DELETE_ON_SUCCESSFUL_COMPLETION
States that the task instance is deleted when it reaches the FINISHED state. |
static java.lang.String |
COPYRIGHT
|
static int |
HIERARCHY_POSITION_FOLLOW_ON_TASK
The task is a follow-on task in the task collaboration hierarchy. |
static int |
HIERARCHY_POSITION_SUB_TASK
The task is a subtask in the task collaboration hierarchy. |
static int |
HIERARCHY_POSITION_TOP_TASK
The task is a toplevel task in the task collaboration hierarchy. |
static int |
KIND_ADMINISTRATIVE
States that the task is an administration task. |
static int |
KIND_HUMAN
States that the task is created and processed by humans. |
static int |
KIND_ORIGINATING
States that the task is a task whose service is invoked and tracked by the Human Task Manager. |
static int |
KIND_PARTICIPATING
States that the task is processed by humans but tracked by the Human Task Manager. |
static int |
KIND_WPC_STAFF_ACTIVITY
Deprecated. States that the task is processed by humans but controlled by the Business Flow Manager. |
static int |
STATE_CLAIMED
States that the task has been claimed. |
static int |
STATE_EXPIRED
States that the task ended because its allowed duration timed-out. |
static int |
STATE_FAILED
States that the task failed to execute. |
static int |
STATE_FAILING
Deprecated. States that the activity is failing. The activity is set to the Failed execution state when all contained running or terminating activities end. |
static int |
STATE_FINISHED
States that the task finished execution successfully. |
static int |
STATE_FORWARDED
States that the task has been completed with a follow-on task. |
static int |
STATE_INACTIVE
States that the task has not yet been started. |
static int |
STATE_PROCESSING_UNDO
Deprecated. States that the activity is retried due to a transaction rollback and that the activity waits for the microflow that it invokes to complete its compensation actions for the first invoke. |
static int |
STATE_READY
States that the task is ready to be claimed. |
static int |
STATE_RUNNING
States that the invocation aka originating task is started and running. |
static int |
STATE_SKIPPED
Deprecated. States that the activity has been skipped because navigation followed a a different control path. |
static int |
STATE_STOPPED
Deprecated. States that the activity is stopped because of a failure. A process administrator can repair the activity by either calling forceRetry or forceComplete. |
static int |
STATE_TERMINATED
States that the task has been terminated because of an external or internal request. |
static int |
STATE_TERMINATING
Deprecated. States that the activity is terminating. The activity is set to the Terminated execution state when all contained running or terminating activities end. |
static int |
STATE_WAITING
Deprecated. States that a receive or pick activity is waiting for a corresponding event to occur. |
static int |
SUBSTITUTION_POLICY_NO_SUBSTITUTION
States that no substitution should take place. |
static int |
SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT
States that only present users should act for absent users. |
static int |
SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT
States that substitutes should act for absent users. |
Method Summary | |
---|---|
java.util.Calendar |
getActivationTime()
Returns the time the task instance is set into the ready state. |
ACOID |
getApplicationDefaultsID()
Returns the ID of the application component that specifies the defaults for the task. |
java.lang.String |
getApplicationName()
Returns the name of the application the task is part of. |
int |
getAutoDeletionMode()
Returns whether the task instance is automatically or conditionally deleted when it reaches an end execution state. |
java.lang.String |
getCalendarName()
Returns the name of the calendar used, for example, for expiration calculations. |
java.util.Calendar |
getCompletionTime()
Returns the time when the task instance reached an end state. |
com.ibm.bpe.api.OID |
getContainmentContextID()
Returns the ID of the context which embraces the task instance. |
int |
getContextAuthorizationOfOwner()
Returns the authorization rights of the task owner to the associated context. |
java.lang.String |
getDefinitionName()
Returns the name of the task definition in the TEL. |
java.lang.String |
getDefinitionNamespace()
Returns the namespace of the task definition in the TEL. |
java.util.Calendar |
getDeletionTime()
Returns the time when the task is deleted. |
java.lang.String |
getDescription(java.util.Locale arg0)
Returns the description in the specified locale. |
java.lang.String |
getDisplayName(java.util.Locale arg0)
Returns the display name in the specified locale. |
java.util.Calendar |
getDueTime()
Returns the time when the task is due. |
java.lang.String |
getDurationUntilDeleted()
Returns the duration that the task is kept after it has reached an end state. |
java.lang.String |
getDurationUntilDue()
Returns the duration that may pass before the task becomes due. |
java.lang.String |
getDurationUntilExpires()
Returns the duration when the task expires once it is activated. |
java.lang.String |
getEventHandlerName()
Returns the name of the associated event handler. |
java.util.Calendar |
getExpirationTime()
Returns the time when the task instance expires or has expired. |
java.util.Calendar |
getFirstActivationTime()
Returns the time the task instance is set into the ready state for the first time. |
TKIID |
getFollowOnTaskID()
Returns the object ID of the next task instance in a sequence. |
TKIID |
getID()
Returns the object identifier. |
java.lang.String |
getInputMessageTypeName()
Returns the name of the input message type. |
java.lang.String |
getJNDINameOfCalendar()
Returns the JNDI name of a user-defined calendar. |
java.lang.String |
getJNDINameOfStaffPluginProvider()
Returns the JNDI name of a user-defined people directory configuation. |
int |
getKind()
Returns the kind of the task. |
java.util.Calendar |
getLastModificationTime()
Returns the last time a property of the task instance changed. |
java.util.Calendar |
getLastStateChangeTime()
Returns the last time the state of the task instance changed. |
java.util.List |
getLocalesOfDescriptions()
Returns the locales of all descriptions. |
java.util.List |
getLocalesOfDisplayNames()
Returns the locales of all display names. |
java.lang.String |
getName()
Returns the name of the task instance. |
java.lang.String |
getNamespace()
Returns the namespace that categorizes the task instance. |
java.lang.String |
getOriginator()
Returns the user ID of the user that created the task instance or on whose behalf the task instance was created. |
java.lang.String |
getOutputMessageTypeName()
Returns the name of the output message type. |
java.lang.String |
getOwner()
Returns the owner of the task instance. |
com.ibm.bpe.api.OID |
getParentContextID()
Returns the object ID of the parent context of the task instance. |
int |
getPositionInHierarchy()
Returns the position in a possible task instance hierarchy. |
java.lang.Integer |
getPriority()
Returns the priority of the task instance. |
java.util.Calendar |
getResumptionTime()
Returns the resumption time of the task instance if the task instance is suspended and is to be resumed automatically. |
java.lang.String |
getStarter()
Returns the starter of the task instance. |
java.util.Calendar |
getStartTime()
Returns the time when execution of the task started. |
int |
getState()
Returns the state of the task instance. |
int |
getSubstitutionPolicy()
Returns the substitution policy that takes place when people assignments are performed. |
TKTID |
getTaskTemplateID()
Returns the object ID of the task template this instance is derived from. |
java.lang.String |
getTaskTemplateName()
Returns the name of the task template this instance is derived from. |
TKIID |
getTopLevelTaskID()
Returns the object ID of the topmost task instance in a hierarchy of tasks. |
java.lang.String |
getType()
Returns the type of the task. |
boolean |
isAdHoc()
States whether the task has been created ad-hoc. |
boolean |
isBusinessRelevant()
States whether the task is a business relevant or an "auxiliary" step. |
boolean |
isChild()
States for standalone tasks whether the task instance runs dependently of its parent or not. |
boolean |
isEscalated()
States whether an escalation occurred. |
boolean |
isInline()
States whether the task is an inline task or not. |
boolean |
isSuspended()
States whether the task instance is suspended or not. |
boolean |
isWaitingForSubTask()
States whether the task is waiting for the completion of a subtask. |
void |
setBusinessRelevance(boolean businessRelevance)
Sets whether the task is a business relevant or an "auxiliary" step. |
void |
setContextAuthorizationOfOwner(int contextAuthorization)
Sets the authorization rights of the task owner to the associated context. |
void |
setDescription(java.lang.String description,
java.util.Locale locale)
Sets the description in the specified locale. |
void |
setDisplayName(java.lang.String displayName,
java.util.Locale locale)
Sets the display name in the specified locale. |
void |
setDurationUntilDeleted(java.lang.String durationUntilDeleted)
Sets the duration that passes until the task is deleted after it reached an end state. |
void |
setDurationUntilDue(java.lang.String durationUntilDue)
Sets the duration the task is expected to become due. |
void |
setEventHandlerName(java.lang.String eventHandlerName)
Sets the name of the associated event handler. |
void |
setName(java.lang.String name)
Sets the name of the task instance. |
void |
setNamespace(java.lang.String namespace)
Sets the namespace for the task name and type properties. |
void |
setParentContextID(com.ibm.bpe.api.OID parentContextID)
Sets the object ID of the parent context. |
void |
setPriority(java.lang.Integer priority)
Sets the priority of the task instance. |
void |
setSupportsClaimIfSuspended(boolean supportsClaimSuspended)
Sets whether the task can be claimed if it is suspended. |
void |
setSupportsDelegation(boolean supportsDelegation)
Sets whether the task supports delegation, for example, by transferring work items. |
void |
setSupportsFollowOnTasks(boolean supportsFollowOnTask)
Sets whether the task supports the creation of follow-on tasks. |
void |
setSupportsSubTasks(boolean supportsSubTask)
Sets whether the task supports the creation of subtasks. |
void |
setType(java.lang.String type)
Sets the type of the task instance. |
boolean |
supportsAutomaticClaim()
States whether the task is claimed automatically when it becomes ready. |
boolean |
supportsClaimIfSuspended()
States whether the task can be claimed even if it is suspended. |
boolean |
supportsDelegation()
States whether the task supports delegation, for example, by transferring work items. |
boolean |
supportsFollowOnTasks()
States whether the task supports the creation of follow-on tasks. |
boolean |
supportsSubTasks()
States whether the task supports the creation of subtasks. |
Field Detail |
---|
static final java.lang.String COPYRIGHT
static final int STATE_STOPPED
static final int STATE_WAITING
static final int STATE_INACTIVE
static final int STATE_EXPIRED
static final int STATE_FORWARDED
static final int STATE_FAILING
static final int STATE_READY
static final int STATE_RUNNING
static final int STATE_TERMINATED
static final int STATE_TERMINATING
static final int STATE_CLAIMED
static final int STATE_FAILED
static final int STATE_PROCESSING_UNDO
static final int STATE_SKIPPED
static final int STATE_FINISHED
static final int KIND_ORIGINATING
static final int KIND_WPC_STAFF_ACTIVITY
static final int KIND_ADMINISTRATIVE
static final int KIND_HUMAN
static final int KIND_PARTICIPATING
static final int AUTH_NONE
static final int AUTH_READER
static final int HIERARCHY_POSITION_TOP_TASK
static final int HIERARCHY_POSITION_FOLLOW_ON_TASK
static final int HIERARCHY_POSITION_SUB_TASK
static final int AUTO_DELETE_ON_COMPLETION
static final int AUTO_DELETE_ON_SUCCESSFUL_COMPLETION
static final int SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT
static final int SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT
static final int SUBSTITUTION_POLICY_NO_SUBSTITUTION
Method Detail |
---|
TKIID getID()
int getState()
boolean isSuspended()
boolean isAdHoc()
boolean isInline()
java.util.Calendar getActivationTime()
java.util.Calendar getFirstActivationTime()
java.util.Calendar getCompletionTime()
java.util.Calendar getLastModificationTime()
java.util.Calendar getLastStateChangeTime()
java.util.Calendar getExpirationTime()
java.lang.String getOriginator()
java.lang.String getStarter()
java.lang.String getOwner()
com.ibm.bpe.api.OID getContainmentContextID()
com.ibm.bpe.api.OID getParentContextID()
java.lang.String getName()
int getKind()
Possible values are: KIND_HUMAN, KIND_ORIGINATING, KIND_PARTICIPATING, KIND_ADMINISTRATIVE, KIND_WPC_STAFF_ACTIVITY.
java.lang.String getDisplayName(java.util.Locale arg0)
If no locale is specified, the display name in the default locale is returned or any available display name, if there is only a single display name.
arg0
- The locale for which the display name is to be provided.java.util.List getLocalesOfDisplayNames()
java.lang.String getDescription(java.util.Locale arg0)
If no locale is specified, the description in the default locale is returned or any available description, if there is only a single description. References to variable members specified as %variableName.memberName% are resolved.
arg0
- The locale for which the description is to be provided.java.util.List getLocalesOfDescriptions()
boolean isBusinessRelevant()
java.lang.String getInputMessageTypeName()
java.lang.String getOutputMessageTypeName()
ACOID getApplicationDefaultsID()
boolean supportsAutomaticClaim()
java.lang.String getCalendarName()
getJNDINameOfCalendar
.
For details on calendars refer to the WebSphere Application Server documentation.
java.lang.String getJNDINameOfCalendar()
getCalendarName
.
For details on calendars refer to the WebSphere Application Server documentation.
java.util.Calendar getDueTime()
duration
until due time.
If the due time is not set, null is returned.
Note that the task manager does not check whether a task is overdue. Instead, the escalation concept can be used to trigger notifications.
java.lang.String getDurationUntilDeleted()
A specification "DURATION_ZERO" means that the task is deleted immediately. A specification "DURATION_INFINITE" means that the task is not deleted automatically.
If not set, then stand-alone invocation or collaboration tasks are kept whereas stand-alone to-do tasks are deleted immediately. Collaboration, invocation, and to-do tasks are also known as human, originating, and participating tasks.
Inline tasks are always deleted together with their container, for example, the process instance.
Note that this setting is checked depending on the automatic deletion mode -
AutoDeletionMode
.
java.lang.String getDurationUntilDue()
setDurationUntilDue
.
java.lang.String getDurationUntilExpires()
boolean isEscalated()
java.lang.String getJNDINameOfStaffPluginProvider()
java.lang.String getNamespace()
java.lang.Integer getPriority()
java.util.Calendar getStartTime()
boolean supportsDelegation()
boolean supportsSubTasks()
TKIID getTopLevelTaskID()
TKIID getFollowOnTaskID()
TKTID getTaskTemplateID()
java.lang.String getTaskTemplateName()
java.lang.String getType()
boolean isWaitingForSubTask()
int getContextAuthorizationOfOwner()
Possible values are: AUTH_NONE, AUTH_READER.
boolean supportsClaimIfSuspended()
java.lang.String getEventHandlerName()
int getPositionInHierarchy()
Values are: HIERARCHY_POSITION_TOP_TASK, HIERARCHY_POSITION_SUB_TASK, HIERARCHY_POSITION_FOLLOW_ON_TASK.
java.util.Calendar getResumptionTime()
int getAutoDeletionMode()
AutoDeletionMode
for the possible deletion modes.
End execution states are STATE_FINISHED, STATE_FAILED, STATE_TERMINATED, or STATE_EXPIRED.
Note that the task instance is actually deleted depending on the duration until deletion specification -
refer to getDurationUntilDeleted
.
java.lang.String getDefinitionName()
java.lang.String getDefinitionNamespace()
int getSubstitutionPolicy()
Possible substitution policies are SUBSTITUTION_POLICY_NO_SUBSTITUTION, SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT, SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT.
boolean supportsFollowOnTasks()
java.lang.String getApplicationName()
boolean isChild()
java.util.Calendar getDeletionTime()
duration
until deletion time.
If the deletion time is not set, null is returned.
void setDisplayName(java.lang.String displayName, java.util.Locale locale)
displayName
- The new value of the display name.locale
- The locale for which the display name is set.void setDescription(java.lang.String description, java.util.Locale locale)
description
- The new value of the description.locale
- The locale for which the description is set.void setSupportsClaimIfSuspended(boolean supportsClaimSuspended)
supportsClaimSuspended
- An indication whether the task can be claimed even if it is suspended. True states that
the task can be claimed if it is suspended. False states that the task cannot be claimed
if it is suspended.void setContextAuthorizationOfOwner(int contextAuthorization)
contextAuthorization
- The authorization rights of the task owner for the associated context.
Possible values are: AUTH_NONE, AUTH_READER.
void setName(java.lang.String name)
name
- The new name of the task instance.void setNamespace(java.lang.String namespace)
namespace
- The new namespace of the task instance.void setDurationUntilDue(java.lang.String durationUntilDue)
Note that the due
time is informal only and not used for scheduling.
durationUntilDue
- The duration the task instance is expected to become due. The format of the
duration depends on the calendar that is used and may, for example, be "5days".
Additionally, "DURATION_ZERO" may be specified to indicate that the task is due immediately
and "DURATION_INFINITE" to indicate that the task has no due time.void setDurationUntilDeleted(java.lang.String durationUntilDeleted)
durationUntilDeleted
- The duration that passes until the task instance is deleted. The format of the
duration depends on the calendar that is used and may, for example, be "5days".
Additionally, "DURATION_ZERO" may be specified to indicate that the task is to be deleted immediately
and "DURATION_INFINITE" to indicate that the task is deleted manually.void setPriority(java.lang.Integer priority)
priority
- The priority of the task instance.void setType(java.lang.String type)
type
- The type of the task instance.void setSupportsDelegation(boolean supportsDelegation)
supportsDelegation
- An indication whether the task instance supports delegation. True states
that the task supports delegation. False states that the task does not
support delegation.void setSupportsSubTasks(boolean supportsSubTask)
supportsSubTask
- An indication whether the task instance supports the creation of
subtasks. True states that the task supports the creation
of subtasks. False states that the task
does not support the creation of subtasks.void setBusinessRelevance(boolean businessRelevance)
businessRelevance
- An indication whether the task instance is business relevant. True
states that the task is business relevant. False states that the task is
not business relevant.void setEventHandlerName(java.lang.String eventHandlerName)
eventHandlerName
- The name of the event handler to be associated.void setParentContextID(com.ibm.bpe.api.OID parentContextID)
Changing the parent context has no impact on the task instance itself. You may, however, use this property to group tasks for queries. For example, a process instance object ID (PIID) can group all stand-alone tasks that belong to the specified process instance.
parentContextID
- The object ID of the parent context.void setSupportsFollowOnTasks(boolean supportsFollowOnTask)
supportsFollowOnTask
- An indication whether the task instance supports the creation of
follow-on tasks. True states that the task supports the creation
of follow-on tasks. False states that the task
does not support the creation of follow-on tasks.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |