|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 java.lang.String |
COPYRIGHT
|
static int |
KIND_ADMINISTRATIVE
States that the task is an administrative task. |
static int |
KIND_HUMAN
States that the task is created and processed by a human. |
static int |
KIND_ORIGINATING
States that the task is a machine task whose service is invoked and tracked by the task manager. |
static int |
KIND_PARTICIPATING
States that the task is a human task tracked by the task manager. |
static int |
KIND_WPC_STAFF_ACTIVITY
States that the task is a human task controlled by BFM. |
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
States that the WPC_STAFF_ACTIVITY is failing. |
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 WPC_STAFF_ACTIVITY has not yet been scheduled for execution. |
static int |
STATE_PROCESSING_UNDO
States that the WPC_STAFF_ACTIVITY is retried due to a transaction rollback and that the WPC_STAFF_ACTIVITY waits for the microflow that it invokes to complete its compensation actions for the first invoke. |
static int |
STATE_READY
States that the WPC_STAFF_ACTIVITY is ready to be started. |
static int |
STATE_RUNNING
States that the machine task is started and running. |
static int |
STATE_SKIPPED
States that the WPC_STAFF_ACTIVITY has been skipped because navigation followed a a different control path. |
static int |
STATE_STOPPED
States that the WPC_STAFF_ACTIVITY is stopped because of a failure. |
static int |
STATE_TERMINATED
States that the task has been terminated because of an external or internal request. |
static int |
STATE_TERMINATING
States that the WPC_STAFF_ACTIVITY is terminating. |
static int |
STATE_WAITING
States that a receive or pick WPC_STAFF_ACTIVITY is waiting for a corresponding event to occur. |
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 |
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 |
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 until the task gets deleted after it reached an end state. |
java.lang.String |
getDurationUntilDue()
Returns the duration until the task becomes due. |
java.lang.String |
getDurationUntilExpires()
Returns the duration until 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 will expire or was due to expire. |
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()
Deprecated. Use createInputMessage .
which does not require a type parameter instead of createMessage. |
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 staff plugin. |
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 of the task name and type properties. |
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()
Deprecated. Use createOutputMessage .
createOutputMessage() which does not require a type parameter instead
of createMessage. |
java.lang.String |
getOwner()
Returns the owner of the task instance. |
com.ibm.bpe.api.OID |
getParentContextID()
Returns the ID of the parent application component. |
java.lang.Integer |
getPriority()
Returns the priority of the task instance. |
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. |
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 the hierarchy. |
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 |
isEscalated()
States whether an escalation occurred. |
boolean |
isInline()
States whether the task is an inline WPC_STAFF_ACTIVITY 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 until the task gets 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 ID of the parent application component. |
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 |
setSupportsSubTasks(boolean supportsSubTask)
Sets whether the task supports creation of subtasks and follow-on tasks. |
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 |
supportsSubTasks()
States whether the task supports creation of subtasks and follow-on tasks. |
Field Detail |
public static final java.lang.String COPYRIGHT
public static final int STATE_TERMINATED
public static final int STATE_READY
public static final int STATE_EXPIRED
public static final int STATE_CLAIMED
public static final int STATE_INACTIVE
public static final int STATE_PROCESSING_UNDO
public static final int STATE_SKIPPED
public static final int STATE_FAILED
public static final int STATE_STOPPED
public static final int STATE_RUNNING
public static final int STATE_FINISHED
public static final int STATE_FAILING
public static final int STATE_WAITING
public static final int STATE_FORWARDED
public static final int STATE_TERMINATING
public static final int KIND_WPC_STAFF_ACTIVITY
public static final int KIND_PARTICIPATING
public static final int KIND_HUMAN
public static final int KIND_ADMINISTRATIVE
public static final int KIND_ORIGINATING
public static final int AUTH_READER
public static final int AUTH_NONE
Method Detail |
public TKIID getID()
public int getState()
public boolean isSuspended()
public boolean isAdHoc()
public boolean isInline()
public java.util.Calendar getActivationTime()
public java.util.Calendar getFirstActivationTime()
public java.util.Calendar getCompletionTime()
public java.util.Calendar getLastModificationTime()
public java.util.Calendar getLastStateChangeTime()
public java.util.Calendar getExpirationTime()
getCompletionTime
for the time when the task was actually set into the expired state.
public java.lang.String getOriginator()
public java.lang.String getStarter()
public java.lang.String getOwner()
public com.ibm.bpe.api.OID getContainmentContextID()
public com.ibm.bpe.api.OID getParentContextID()
public java.lang.String getName()
public int getKind()
Possible values are: KIND_HUMAN, KIND_ORIGINATING, KIND_PARTICIPATING, KIND_ADMINISTRATIVE, KIND_WPC_STAFF_ACTIVITY.
public java.lang.String getDisplayName(java.util.Locale arg0)
This method returns the display name in the default locale when a display name in the specified locale is not found. 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.public java.util.List getLocalesOfDisplayNames()
public java.lang.String getDescription(java.util.Locale arg0)
This method returns the description in the default locale when a description in the specified locale is not found. 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.public java.util.List getLocalesOfDescriptions()
public boolean isBusinessRelevant()
public java.lang.String getInputMessageTypeName()
createInputMessage
.
which does not require a type parameter instead of createMessage.
public java.lang.String getOutputMessageTypeName()
createOutputMessage
.
createOutputMessage() which does not require a type parameter instead
of createMessage.
public ACOID getApplicationDefaultsID()
public boolean supportsAutomaticClaim()
public java.lang.String getCalendarName()
getJNDINameOfCalendar
.
For details on calendars refer to the WebSphere Application Server documentation.
public java.lang.String getJNDINameOfCalendar()
getCalendarName
.
For details on calendars refer to the WebSphere Application Server documentation.
public java.util.Calendar getDueTime()
public java.lang.String getDurationUntilDeleted()
public java.lang.String getDurationUntilDue()
getDueTime
.
public java.lang.String getDurationUntilExpires()
public boolean isEscalated()
public java.lang.String getJNDINameOfStaffPluginProvider()
public java.lang.String getNamespace()
public java.lang.Integer getPriority()
public java.util.Calendar getStartTime()
public boolean supportsDelegation()
public boolean supportsSubTasks()
public TKIID getTopLevelTaskID()
public TKIID getFollowOnTaskID()
public TKTID getTaskTemplateID()
public java.lang.String getTaskTemplateName()
public java.lang.String getType()
public boolean isWaitingForSubTask()
public int getContextAuthorizationOfOwner()
Possible values are: AUTH_NONE, AUTH_READER.
public boolean supportsClaimIfSuspended()
public java.lang.String getEventHandlerName()
public 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.public 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.public 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.public void setContextAuthorizationOfOwner(int contextAuthorization)
contextAuthorization
- The authorization rights of the task owner for the associated context.
Possible values are: AUTH_NONE, AUTH_READER.
public void setName(java.lang.String name)
name
- The new name of the task instance.public void setNamespace(java.lang.String namespace)
namespace
- The new namespace of the task instance.public void setDurationUntilDue(java.lang.String durationUntilDue)
getDueTime
.
durationUntilDue
- The duration when the task instance is expected to become due.public void setDurationUntilDeleted(java.lang.String durationUntilDeleted)
durationUntilDeleted
- The duration when the task instance is finally deleted.public void setPriority(java.lang.Integer priority)
priority
- The priority of the task instance.public void setType(java.lang.String type)
type
- The type of the task instance.public 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.public void setSupportsSubTasks(boolean supportsSubTask)
supportsSubTask
- An indication whether the task instance supports creation of subtasks and
follow-on tasks. True states that the task supports creation
of subtasks and follow-on tasks. False states that the task
does not support creation of subtasks and follow-on tasks.public 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.public void setEventHandlerName(java.lang.String eventHandlerName)
eventHandlerName
- The name of the event handler to be associated.public void setParentContextID(com.ibm.bpe.api.OID parentContextID)
parentContextID
- The object ID of the parent application component.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |