com.ibm.task.api
Interface ApplicationComponent

All Superinterfaces:
java.io.Serializable

public interface ApplicationComponent
extends java.io.Serializable

Accesses the properties of an application component.

An application component specifies default values for tasks, for example, default values that control the life-cycle of tasks. These default values can be overwritten by specific values of task templates or task themselves.

There are two pre-defined application components, HTM for the Human Task Manager and BFM for the Business Flow Manager.

Since:
6.0

Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.String getCalendarName()
          Returns the name of the calendar used, for example, for expiration calculations.
 java.lang.String getDurationUntilDeleted()
          Returns the duration until tasks that belong to this application component get deleted after reaching an end state.
 java.lang.String getEventHandlerName()
          Returns the name of the event handler that gets associated to tasks that belong to this component.
 ACOID 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.
 java.lang.String getName()
          Returns the name of the application component.
 boolean isBusinessRelevant()
          States whether a task that belongs to this application component is a business relevant or an "auxiliary" step.
 boolean supportsAutomaticClaim()
          States whether a task that belongs to this application component is claimed automatically when it becomes ready.
 boolean supportsClaimIfSuspended()
          States whether tasks that belong to this application component can be claimed even if they are suspended.
 boolean supportsDelegation()
          States whether tasks that belong to this application component support delegation, for example, by transferring work items.
 boolean supportsSubTasks()
          States whether tasks that belong to this application component support creation of subtasks and follow-on tasks.
 

Field Detail

COPYRIGHT

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

getID

public ACOID getID()
Returns the object identifier.


getName

public java.lang.String getName()
Returns the name of the application component.


supportsAutomaticClaim

public boolean supportsAutomaticClaim()
States whether a task that belongs to this application component 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 that belongs to this application component is a business relevant or an "auxiliary" step. A business relevant step can, for example, be logged into the audit trail.


getDurationUntilDeleted

public java.lang.String getDurationUntilDeleted()
Returns the duration until tasks that belong to this application component get deleted after reaching an end state. If not set, the task is deleted at once.


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.


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.


supportsDelegation

public boolean supportsDelegation()
States whether tasks that belong to this application component support delegation, for example, by transferring work items.


supportsSubTasks

public boolean supportsSubTasks()
States whether tasks that belong to this application component support creation of subtasks and follow-on tasks.


supportsClaimIfSuspended

public boolean supportsClaimIfSuspended()
States whether tasks that belong to this application component can be claimed even if they are suspended. True states that tasks can be claimed if they are suspended. False states that tasks cannot be claimed if they are suspended.


getEventHandlerName

public java.lang.String getEventHandlerName()
Returns the name of the event handler that gets associated to tasks that belong to this component. Returns null if there is no event handler.