com.ibm.task.api
Interface TaskTemplate

All Superinterfaces:
java.io.Serializable

public interface TaskTemplate
extends java.io.Serializable

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().

Since:
6.0

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

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

KIND_PARTICIPATING

public static final int KIND_PARTICIPATING
States that tasks derived from this template are human tasks tracked by the task manager.

See Also:
Constant Field Values

KIND_HUMAN

public static final int KIND_HUMAN
States that tasks derived from this template are created and processed by humans.

See Also:
Constant Field Values

KIND_ADMINISTRATIVE

public static final int KIND_ADMINISTRATIVE
States that tasks derived from this template are administrative tasks.

See Also:
Constant Field Values

KIND_ORIGINATING

public static final int KIND_ORIGINATING
States that tasks derived from this template are machine tasks whose services are invoked and tracked by the task manager.

See Also:
Constant Field Values

AUTH_READER

public static final 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.

See Also:
Constant Field Values

AUTH_NONE

public static final int AUTH_NONE
States that no operations can be executed on the associated context.

See Also:
Constant Field Values

STATE_STOPPED

public static final int STATE_STOPPED
States that the task template has been stopped. Task instances cannot be created from the task template.

See Also:
Constant Field Values

STATE_STARTED

public static final int STATE_STARTED
States that the task template is available for task instance creation.

See Also:
Constant Field Values
Method Detail

getID

public TKTID getID()
Returns the object identifier.


getApplicationDefaultsID

public ACOID getApplicationDefaultsID()
Returns the ID of the application component that specifies the defaults for tasks derived from this template. Any property set explicitly on the task template or task overwrites the defaults provided by the application component.


getApplicationName

public java.lang.String getApplicationName()
Returns the name of the application the task template is part of.


supportsAutomaticClaim

public boolean supportsAutomaticClaim()
States whether a task derived from this template is claimed automatically when it becomes ready. This function requires that there is a single potential owner.


isBusinessRelevant

public boolean isBusinessRelevant()
States whether a task derived from this template is a business relevant or an "auxiliary" step. A business relevant step can, for example, be logged into the audit trail.


isAdHoc

public boolean isAdHoc()
States whether the task template has been created ad-hoc. True states that the task template has been created ad-hoc. False states that the task template has been deployed.


isInline

public boolean isInline()
States whether the task template describes an inline WPC_STAFF_ACTIVITY or not. True states that the task template describes an inline WPC_STAFF_ACTIVITY. False states that the task template does not describe an inline WPC_STAFF_ACTIVITY.


getCalendarName

public java.lang.String getCalendarName()
Returns the name of the calendar used, for example, for expiration calculations. If not set, null is returned and the WebSphere default calendar is used. If a JNDI name for a user-defined calendar is specified, then the calendar name is the name of a method implementing that user-defined calendar - see getJNDINameOfCalendar.

For details on calendars refer to the WebSphere Application Server documentation.


getContainmentContextID

public com.ibm.bpe.api.OID getContainmentContextID()
Returns the ID of the context the task template belongs to. This ID is used for task template and instance deletion. In other words, when the context is deleted, the task template and derived instances are also deleted.


getDescription

public java.lang.String getDescription(java.util.Locale arg0)
Returns the description in the specified locale. 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.

Parameters:
arg0 - The locale for which the description is to be provided.

getLocalesOfDescriptions

public java.util.List getLocalesOfDescriptions()
Returns the locales of all descriptions. Returns an empty list when there are no descriptions.


getDisplayName

public java.lang.String getDisplayName(java.util.Locale arg0)
Returns the display name in the specified locale. 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.

Parameters:
arg0 - The locale for which the display name is to be provided.

getLocalesOfDisplayNames

public java.util.List getLocalesOfDisplayNames()
Returns the locales of all display names. Returns an empty list when there are no display names.


getDurationUntilDeleted

public java.lang.String getDurationUntilDeleted()
Returns the duration until tasks derived from this template get deleted after reaching an end state. If not set, the task is deleted at once.


getDurationUntilDue

public java.lang.String getDurationUntilDue()
Returns the duration until tasks derived from this template become due.


getDurationUntilExpires

public java.lang.String getDurationUntilExpires()
Returns the duration until tasks derived from this template expire once they are activated.


getJNDINameOfCalendar

public java.lang.String getJNDINameOfCalendar()
Returns the JNDI name of a user-defined calendar. If not set, null is returned and a WebSphere supported calendar is used - see getCalendarName.

For details on calendars refer to the WebSphere Application Server documentation.


getJNDINameOfStaffPluginProvider

public java.lang.String getJNDINameOfStaffPluginProvider()
Returns the JNDI name of a user-defined staff plugin.


getKind

public int getKind()
Returns the kind of tasks derived from this template.

Possible values are: KIND_HUMAN, KIND_ORIGINATING, KIND_PARTICIPATING, KIND_ADMINISTRATIVE.


getName

public java.lang.String getName()
Returns the name of the task template.


getNamespace

public java.lang.String getNamespace()
Returns the namespace associated to the task template name and type properties.


getPriority

public java.lang.Integer getPriority()
Returns the priority of tasks derived from this template. 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.


getType

public java.lang.String getType()
Returns the type of the task template. A type can be used to categorize tasks derived from this template. Returns null when there is no associated type.


supportsDelegation

public boolean supportsDelegation()
States whether tasks derived from this template support delegation, for example, by transferring work items.


supportsSubTasks

public boolean supportsSubTasks()
States whether tasks derived from this template support creation of subtasks or follow-on tasks.


supportsClaimIfSuspended

public boolean supportsClaimIfSuspended()
States whether tasks derived from this template can be claimed even if they are suspended. True states that a task can be claimed if it is suspended. False states that a task cannot be claimed if it is suspended.


getValidFromTime

public java.util.Calendar getValidFromTime()
Returns the time the task template became or becomes valid.


getContextAuthorizationOfOwner

public int getContextAuthorizationOfOwner()
Returns the authorization rights of owners of tasks that are derived from this template to the associated context.

Possible values are: AUTH_NONE, AUTH_READER.


getEventHandlerName

public java.lang.String getEventHandlerName()
Returns the name of the associated event handler. Returns null if there is no event handler.


getState

public int getState()
States whether the task template is started or stopped.

Returns either STATE_STARTED or STATE_STOPPED.