com.ibm.task.api

Interface WorkBasket

All Superinterfaces:
java.io.Serializable

  1. public interface WorkBasket
  2. extends java.io.Serializable
Accesses the properties of a work basket.

Work baskets provide for a means to deal with a large number of tasks in an organization. They allow to group tasks into meaningful subsets based, for example, on responsibilities, organizational units, or topics. Tasks are then routed from one work basket to another until eventually ending up in a work basket from where a business user takes the task, works on it and completes it.

Work baskets thus provide an alternate way of assigning tasks to people. They can be used instead or combined with people resolution on tasks. Work baskets not only structure the entire set of tasks into smaller pieces but also help control the processing of these tasks by monitoring the remaining tasks in the work basket.

In work basket scenarios, all tasks are residing in a specific work basket. There are no tasks without a work basket association. The initial assignment to a work basket is done based on the type of work, that is, the type of the task.

There are typically four types of work baskets:

Tasks are usually first assigned to a group work basket or a topic work basket. From there they are transferred to a more specific work basket, which is in the end an individual work basket. The tasks are then processed by the individual,

Since:
6.2.0.3

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. java.lang.String
DEFAULT_CONTAINER_JNDI_NAME_OF_STAFF_PLUGIN_PROVIDER
States the default value for getJNDINameOfStaffPluginProvider.
  1. static
  2. int
SUBSTITUTION_POLICY_NO_SUBSTITUTION
States that no substitution should take place.
  1. static
  2. int
SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT
States that only present users should act for absent users.
  1. static
  2. int
SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT
States that substitutes should act for absent users.
  1. static
  2. int
TYPE_CLEARANCE
States that tasks contained in this work basket cannot be processed as they are, but require special care.
  1. static
  2. int
TYPE_GROUP
States that tasks contained in this work basket are to be processed by a certain group of people, for example, teams or departments.
  1. static
  2. int
TYPE_INDIVIDUAL
States that tasks contained in this work basket are assigned to a specific person.
  1. static
  2. int
TYPE_TOPIC
States that tasks contained in this work basket belong to a certain theme or topic.

Method Summary

Modifier and Type Method and Description
  1. java.util.Calendar
getCreationTime()
Returns the creation time of the work basket.
  1. java.lang.String
getCustomText1()
Returns the custom text specified as custom text one.
  1. java.lang.String
getCustomText2()
Returns the custom text specified as custom text two.
  1. java.lang.String
getCustomText3()
Returns the custom text specified as custom text three.
  1. java.lang.String
getCustomText4()
Returns the custom text specified as custom text four.
  1. java.lang.String
getCustomText5()
Returns the custom text specified as custom text five.
  1. java.lang.String
getCustomText6()
Returns the custom text specified as custom text six.
  1. java.lang.String
getCustomText7()
Returns the custom text specified as custom text seven.
  1. java.lang.String
getCustomText8()
Returns the custom text specified as custom text eight.
  1. java.lang.String
getDefaultQueryTable()
Returns the name of the default query table associated to the work basket.
  1. java.lang.String
getDescription(java.util.Locale arg0)
Returns the description in the specified locale.
  1. java.lang.String
getDisplayName(java.util.Locale arg0)
Returns the display name in the specified locale.
  1. java.util.List
getDistributionTargets()
Returns a list of object IDs ( WBIDs) of work baskets that are distribution targets of this work basket.
  1. WBID
getID()
Returns the object identifier.
  1. java.lang.String
getJNDINameOfStaffPluginProvider()
Returns the JNDI name of a user-defined people directory configuration.
  1. java.util.Calendar
getLastModificationTime()
Returns the last time a property of the work basket changed.
  1. java.util.List
getLocalesOfDescriptions()
Returns the locales of all descriptions.
  1. java.util.List
getLocalesOfDisplayNames()
Returns the locales of all display names.
  1. java.lang.String
getName()
Returns the name of the work basket.
  1. java.lang.String
getOwner()
Returns the owner of the work basket.
  1. int
getSubstitutionPolicy()
Returns the substitution policy that takes place when people assignments are performed.
  1. int
getType()
Returns the type of the work basket.

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

DEFAULT_CONTAINER_JNDI_NAME_OF_STAFF_PLUGIN_PROVIDER

  1. static final java.lang.String DEFAULT_CONTAINER_JNDI_NAME_OF_STAFF_PLUGIN_PROVIDER
States the default value for getJNDINameOfStaffPluginProvider.
See Also:

TYPE_CLEARANCE

  1. static final int TYPE_CLEARANCE
States that tasks contained in this work basket cannot be processed as they are, but require special care.
See Also:

TYPE_TOPIC

  1. static final int TYPE_TOPIC
States that tasks contained in this work basket belong to a certain theme or topic.
See Also:

TYPE_GROUP

  1. static final int TYPE_GROUP
States that tasks contained in this work basket are to be processed by a certain group of people, for example, teams or departments.
See Also:

TYPE_INDIVIDUAL

  1. static final int TYPE_INDIVIDUAL
States that tasks contained in this work basket are assigned to a specific person.
See Also:

SUBSTITUTION_POLICY_NO_SUBSTITUTION

  1. static final int SUBSTITUTION_POLICY_NO_SUBSTITUTION
States that no substitution should take place. All users resolved by people assignment criteria are returned.
See Also:

SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT

  1. static final int SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT
States that substitutes should act for absent users. If all substitutes are absent or explicitely excluded by people assignment criteria, default people assignments are performed, for example, task administrators become potential owners.
See Also:

SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT

  1. static final int SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT
States that only present users should act for absent users. If all users and their subsitutes are absent or excluded by people assignment criteria, users originally resolved are returned.
See Also:

Method Detail

getID

  1. WBID getID()
Returns the object identifier.

getName

  1. java.lang.String getName()
Returns the name of the work basket.

getType

  1. int getType()
Returns the type of the work basket.

Possible types are TYPE_GROUP, TYPE_TOPIC, TYPE_INDIVIDUAL, or TYPE_CLEARANCE.


getDisplayName

  1. 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

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

getDescription

  1. 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.

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

getLocalesOfDescriptions

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

getOwner

  1. java.lang.String getOwner()
Returns the owner of the work basket.

getDistributionTargets

  1. java.util.List getDistributionTargets( )
Returns a list of object IDs ( WBIDs) of work baskets that are distribution targets of this work basket. Returns an empty list when there are no distribution targets.

getDefaultQueryTable

  1. java.lang.String getDefaultQueryTable( )
Returns the name of the default query table associated to the work basket. Returns null if no query table is associated.

getJNDINameOfStaffPluginProvider

  1. java.lang.String getJNDINameOfStaffPluginProvider( )
Returns the JNDI name of a user-defined people directory configuration.

getSubstitutionPolicy

  1. int getSubstitutionPolicy()
Returns the substitution policy that takes place when people assignments are performed.

Possible substitution policies are SUBSTITUTION_POLICY_NO_SUBSTITUTION, SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT, SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT.


getCustomText1

  1. java.lang.String getCustomText1( )
Returns the custom text specified as custom text one. Returns null if not specified.

getCustomText2

  1. java.lang.String getCustomText2( )
Returns the custom text specified as custom text two. Returns null if not specified.

getCustomText3

  1. java.lang.String getCustomText3( )
Returns the custom text specified as custom text three. Returns null if not specified.

getCustomText4

  1. java.lang.String getCustomText4( )
Returns the custom text specified as custom text four. Returns null if not specified.

getCustomText5

  1. java.lang.String getCustomText5( )
Returns the custom text specified as custom text five. Returns null if not specified.

getCustomText6

  1. java.lang.String getCustomText6( )
Returns the custom text specified as custom text six. Returns null if not specified.

getCustomText7

  1. java.lang.String getCustomText7( )
Returns the custom text specified as custom text seven. Returns null if not specified.

getCustomText8

  1. java.lang.String getCustomText8( )
Returns the custom text specified as custom text eight. Returns null if not specified.

getCreationTime

  1. java.util.Calendar getCreationTime( )
Returns the creation time of the work basket.

getLastModificationTime

  1. java.util.Calendar getLastModificationTime( )
Returns the last time a property of the work basket changed.