|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaskTemplate
Accesses the properties of a task template.
A task template is a versioned model that contains the specification of a task. The task can be an operation performed by a person, for example, the completion of a form or document, an operation performed by a machine, or a ProcessChoreographer subprocess.
A task template has input, output, and faults to describe data passed to tasks derived from the template and data resulting from task execution. A task template can be instantiated by issuing appropriate requests, for example, createTask().
Field Summary | |
---|---|
static int |
ASSIGNMENT_TYPE_PARALLEL
States that a task derived from this template can be assigned to multiple persons in parallel. |
static int |
ASSIGNMENT_TYPE_SINGLE
States that a task derived from this template can only be assigned to a single person. |
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 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 derived from this template is deleted when the duration until deletion has passed. |
static int |
AUTO_DELETE_ON_SUCCESSFUL_COMPLETION
States that a task instance derived from this template is deleted when it reaches the FINISHED state. |
static int |
AUTONOMY_CHILD
States that task instances derived from this template run dependently of a potential parent process. |
static int |
AUTONOMY_NOT_APPLICABLE
States that the autonomy flag is not applicable. |
static int |
AUTONOMY_PEER
States that task instances derived from this template run independently of a potential parent process. |
static java.lang.String |
COPYRIGHT
|
static int |
INHERITED_AUTH_ADMINISTRATOR
States that administrator authorizations of all parent tasks in the parent task hierarchy are inherited by a subtask derived from this template. |
static int |
INHERITED_AUTH_ALL
States that, additionally to the administrators, all other authorizations for parent tasks in the parent task hierarchy are inherited as reader authorization by a subtask derived from this template. |
static int |
INHERITED_AUTH_NONE
States that no authorization is inherited from parent tasks by a subtask derived from this template. |
static int |
KIND_ADMINISTRATIVE
States that tasks derived from this template are administration tasks. |
static int |
KIND_HUMAN
States that tasks derived from this template are created and processed by humans. |
static int |
KIND_ORIGINATING
States that tasks derived from this template are tasks whose services are invoked and tracked by the Human Task Manager. |
static int |
KIND_PARTICIPATING
States that tasks derived from this template are processed by humans but tracked by the Human Task Manager. |
static int |
STATE_STARTED
States that the task template is available for task instance creation. |
static int |
STATE_STOPPED
States that the task template has been stopped. |
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 | |
---|---|
ACOID |
getApplicationDefaultsID()
Returns the ID of the application component that specifies the defaults for tasks derived from this template. |
java.lang.String |
getApplicationName()
Returns the name of the application the task template is part of. |
int |
getAssignmentType()
Returns whether tasks derived from this template can be assigned to a single person or to multiple persons in parallel. |
int |
getAutoDeletionMode()
Returns whether an instance derived from the task template is automatically or conditionally deleted when it reaches an end execution state. |
int |
getAutonomy()
States for stand-alone tasks whether an instance of the task template runs dependently of a potential parent or not. |
java.lang.String |
getCalendarName()
Returns the name of the calendar used, for example, for expiration calculations. |
OID |
getContainmentContextID()
Returns the ID of the context the task template belongs to. |
int |
getContextAuthorizationOfOwner()
Returns the authorization rights of owners of tasks that are derived from this template to the associated context. |
java.lang.String |
getDefinitionName()
Returns the name of the task template definition in the TEL. |
java.lang.String |
getDefinitionNamespace()
Returns the namespace of the task template definition in the TEL. |
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.lang.String |
getDurationUntilDeleted()
Returns the duration that task instances derived from this template are kept after they have reached an end state. |
java.lang.String |
getDurationUntilDue()
Returns the duration when tasks derived from this template become due. |
java.lang.String |
getDurationUntilExpires()
Returns the duration when tasks derived from this template expire once they are activated. |
java.lang.String |
getEventHandlerName()
Returns the name of the associated event handler. |
TKTID |
getID()
Returns the object identifier. |
int |
getInheritedAuthorization()
States for a subtask derived from this template which kind of authorization is inherited from parent tasks. |
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 configuration. |
int |
getKind()
Returns the kind of tasks derived from this template. |
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 template. |
java.lang.String |
getNamespace()
Returns the namespace that categorizes the task template. |
java.lang.Integer |
getPriority()
Returns the priority of tasks derived from this template. |
java.lang.String |
getPriorityDefinition()
Returns the priority definition for tasks derived from this template. |
int |
getState()
States whether the task template is started or stopped. |
int |
getSubstitutionPolicy()
Returns the substitution policy that takes place when people assignments are performed for tasks derived from this task template. |
java.lang.String |
getType()
Returns the type of the task template. |
java.util.Calendar |
getValidFromTime()
Returns the time the task template became or becomes valid. |
java.lang.String |
getWorkBasketName()
Returns the name of the work basket tasks derived from this template should belong to. |
boolean |
isAdHoc()
States whether the task template has been created ad-hoc. |
boolean |
isBusinessRelevant()
States whether a task derived from this template is a business relevant or an "auxiliary" step. |
boolean |
isInline()
States whether the task template describes an inline task or not. |
boolean |
supportsAutomaticClaim()
States whether a task derived from this template is claimed automatically when it becomes ready. |
boolean |
supportsClaimIfSuspended()
States whether tasks derived from this template can be claimed even if they are suspended. |
boolean |
supportsDelegation()
States whether tasks derived from this template support delegation, for example, by transferring work items. |
boolean |
supportsFollowOnTasks()
States whether tasks derived from this template support the creation of follow-on tasks. |
boolean |
supportsSubTasks()
States whether tasks derived from this template support the creation of subtasks. |
Field Detail |
---|
static final java.lang.String COPYRIGHT
static final int KIND_PARTICIPATING
static final int KIND_HUMAN
static final int KIND_ADMINISTRATIVE
static final int KIND_ORIGINATING
static final int AUTH_READER
static final int AUTH_NONE
static final int STATE_STARTED
static final int STATE_STOPPED
static final int AUTO_DELETE_ON_SUCCESSFUL_COMPLETION
static final int AUTO_DELETE_ON_COMPLETION
static final int SUBSTITUTION_POLICY_NO_SUBSTITUTION
static final int SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT
static final int SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT
static final int AUTONOMY_PEER
static final int AUTONOMY_CHILD
static final int AUTONOMY_NOT_APPLICABLE
static final int ASSIGNMENT_TYPE_PARALLEL
static final int ASSIGNMENT_TYPE_SINGLE
static final int INHERITED_AUTH_NONE
static final int INHERITED_AUTH_ADMINISTRATOR
static final int INHERITED_AUTH_ALL
Method Detail |
---|
TKTID getID()
ACOID getApplicationDefaultsID()
java.lang.String getApplicationName()
boolean supportsAutomaticClaim()
boolean isBusinessRelevant()
boolean isAdHoc()
boolean isInline()
java.lang.String getCalendarName()
getJNDINameOfCalendar
.
For details on calendars refer to the WebSphere Application Server documentation.
OID getContainmentContextID()
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()
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 getDurationUntilDeleted()
A specification TimerSpecification.DURATION_IMMEDIATE
means that task instances are deleted immediately.
A specification TimerSpecification.DURATION_INFINITE
means that task instances are 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()
java.lang.String getDurationUntilExpires()
java.lang.String getJNDINameOfCalendar()
getCalendarName
.
For details on calendars refer to the WebSphere Application Server documentation.
java.lang.String getJNDINameOfStaffPluginProvider()
int getKind()
Possible values are: KIND_HUMAN, KIND_ORIGINATING, KIND_PARTICIPATING, KIND_ADMINISTRATIVE.
java.lang.String getName()
java.lang.String getNamespace()
java.lang.String getDefinitionName()
java.lang.String getDefinitionNamespace()
java.lang.Integer getPriority()
getPriorityDefinition
.
No special meaning is associated with this property. Escalations may, however, increase the priority of associated tasks. A caller can, for example, use it for sorting a list of tasks.
java.lang.String getType()
boolean supportsDelegation()
boolean supportsSubTasks()
boolean supportsClaimIfSuspended()
java.util.Calendar getValidFromTime()
int getContextAuthorizationOfOwner()
Possible values are: AUTH_NONE, AUTH_READER.
java.lang.String getEventHandlerName()
int getState()
Returns either STATE_STARTED or STATE_STOPPED.
int getAutoDeletionMode()
AutoDeletionMode
for the possible deletion modes.
End execution states are STATE_FINISHED, STATE_FAILED, STATE_TERMINATED, or STATE_EXPIRED.
Note that task instances are actually deleted depending on the duration until deletion specification -
refer to getDurationUntilDeleted
.
java.lang.String getPriorityDefinition()
The priority is evaluated when a task is started.
When the priority cannot be evaluated, for example, the definition cannot be
converted to a numeric value, then the default for priorities, 5, is taken.
When there is no priority definition, then the value from the priority property
is taken - see getPriority
.
No special meaning is associated with this property. Escalations may, however, increase the priority of associated tasks. A caller can, for example, use it for sorting a list of tasks.
int getSubstitutionPolicy()
Possible substitution policies are SUBSTITUTION_POLICY_NO_SUBSTITUTION, SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT, SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT.
boolean supportsFollowOnTasks()
int getAutonomy()
For inline tasks, AUTONOMY_NOT_APPLICABLE is returned. Inline tasks are always dependent on their parents.
int getAssignmentType()
Possible assignment types are ASSIGNMENT_TYPE_SINGLE, ASSIGNMENT_TYPE_PARALLEL.
int getInheritedAuthorization()
Possible values are INHERITED_AUTH_NONE, INHERITED_AUTH_ADMINISTRATOR, INHERITED_AUTH_ALL.
java.lang.String getWorkBasketName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |