|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
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 java.lang.String |
COPYRIGHT
|
static int |
KIND_ADMINISTRATIVE
States that tasks derived from this template are administrative 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 machine tasks whose services are invoked and tracked by the task manager. |
static int |
KIND_PARTICIPATING
States that tasks derived from this template are human tasks tracked by the 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. |
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. |
java.lang.String |
getCalendarName()
Returns the name of the calendar used, for example, for expiration calculations. |
com.ibm.bpe.api.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 |
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 until tasks derived from this template get deleted after reaching an end state. |
java.lang.String |
getDurationUntilDue()
Returns the duration until tasks derived from this template become due. |
java.lang.String |
getDurationUntilExpires()
Returns the duration until 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. |
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 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 associated to the task template name and type properties. |
java.lang.Integer |
getPriority()
Returns the priority of tasks derived from this template. |
int |
getState()
States whether the task template is started or stopped. |
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. |
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 WPC_STAFF_ACTIVITY 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 |
supportsSubTasks()
States whether tasks derived from this template support creation of subtasks or follow-on tasks. |
Field Detail |
public static final java.lang.String COPYRIGHT
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
public static final int STATE_STOPPED
public static final int STATE_STARTED
Method Detail |
public TKTID getID()
public ACOID getApplicationDefaultsID()
public java.lang.String getApplicationName()
public boolean supportsAutomaticClaim()
public boolean isBusinessRelevant()
public boolean isAdHoc()
public boolean isInline()
public java.lang.String getCalendarName()
getJNDINameOfCalendar
.
For details on calendars refer to the WebSphere Application Server documentation.
public com.ibm.bpe.api.OID getContainmentContextID()
public java.lang.String getDescription(java.util.Locale arg0)
arg0
- The locale for which the description is to be provided.public java.util.List getLocalesOfDescriptions()
public java.lang.String getDisplayName(java.util.Locale arg0)
arg0
- The locale for which the display name is to be provided.public java.util.List getLocalesOfDisplayNames()
public java.lang.String getDurationUntilDeleted()
public java.lang.String getDurationUntilDue()
public java.lang.String getDurationUntilExpires()
public java.lang.String getJNDINameOfCalendar()
getCalendarName
.
For details on calendars refer to the WebSphere Application Server documentation.
public java.lang.String getJNDINameOfStaffPluginProvider()
public int getKind()
Possible values are: KIND_HUMAN, KIND_ORIGINATING, KIND_PARTICIPATING, KIND_ADMINISTRATIVE.
public java.lang.String getName()
public java.lang.String getNamespace()
public java.lang.Integer getPriority()
public java.lang.String getType()
public boolean supportsDelegation()
public boolean supportsSubTasks()
public boolean supportsClaimIfSuspended()
public java.util.Calendar getValidFromTime()
public int getContextAuthorizationOfOwner()
Possible values are: AUTH_NONE, AUTH_READER.
public java.lang.String getEventHandlerName()
public int getState()
Returns either STATE_STARTED or STATE_STOPPED.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |