com.ibm.task.spi

Interface StaffQueryResult


  1. public interface StaffQueryResult
This interface provides methods to handle the result of a staff query. The staff query result is returned by a staff plugin.
Since:
6.0.2

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. int
RESULT_TYPE_EVERYBODY
States that everybody is qualifying.
  1. static
  2. int
RESULT_TYPE_GROUPIDS
States that a set of qualifying group IDs is returned.
  1. static
  2. int
RESULT_TYPE_NOBODY
States that no one is qualifying.
  1. static
  2. int
RESULT_TYPE_USERIDS
States that a set of qualifying user IDs is returned.
  1. static
  2. int
RESULT_TYPE_USERIDS_AND_GROUPIDS
States that user and group IDs are returned.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String[]
getGroupIDs()
This method returns the set of group IDs when the result type indicates that group IDs are returned.
  1. int
getResultType()
This method returns an indicator that describes the content of the staff result set.
  1. java.util.Collection
getUserData()
This method returns a collection of UserData objects.
  1. java.util.Map
getUserDataMap()
This method returns a Map containing key-value pairs with user name as key and a UserData object as values.
  1. com.ibm.bpe.api.UTCDate
getValidUntilDate()
This method returns the time when the cached user collection expires and when it will be newly retrieved using the staff plugin.

Field Detail

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

RESULT_TYPE_NOBODY

  1. static final int RESULT_TYPE_NOBODY
States that no one is qualifying.
See Also:

RESULT_TYPE_EVERYBODY

  1. static final int RESULT_TYPE_EVERYBODY
States that everybody is qualifying.
See Also:

RESULT_TYPE_USERIDS

  1. static final int RESULT_TYPE_USERIDS
States that a set of qualifying user IDs is returned. Note that the set can be empty.
See Also:

RESULT_TYPE_GROUPIDS

  1. static final int RESULT_TYPE_GROUPIDS
States that a set of qualifying group IDs is returned.
See Also:

RESULT_TYPE_USERIDS_AND_GROUPIDS

  1. static final int RESULT_TYPE_USERIDS_AND_GROUPIDS
States that user and group IDs are returned.
See Also:

Method Detail

getResultType

  1. int getResultType()
This method returns an indicator that describes the content of the staff result set.

Possible values are:

  • RESULT_TYPE_NOBODY
  • RESULT_TYPE_EVERYBODY
  • RESULT_TYPE_USERIDS
  • RESULT_TYPE_GROUPIDS
  • RESULT_TYPE_USERIDS_AND_GROUPIDS
Returns:
The staff result set indicator.

getGroupIDs

  1. java.lang.String[] getGroupIDs( )
This method returns the set of group IDs when the result type indicates that group IDs are returned. Otherwise, it returns null.

Note: Currrently, the maximum array size is 1.

Returns:
The group IDs or null.

getValidUntilDate

  1. com.ibm.bpe.api.UTCDate getValidUntilDate( )
This method returns the time when the cached user collection expires and when it will be newly retrieved using the staff plugin. The time is assumed to be in UTC.
Returns:
The expiration time.

getUserData

  1. java.util.Collection getUserData( )
This method returns a collection of UserData objects.

A UserData objects contains attributes like userid, e-mail address and preferred locale.

Note: If the result type is not RESULT_TYPE_USERIDS, 'null' is returned.

Important: If this method is used once, the getUserDataMap() method will return 'null' to prevent the modification of the map normally returned with the getUserDataMap() method.

Returns:
A collection of UserData objects.

getUserDataMap

  1. java.util.Map getUserDataMap()
This method returns a Map containing key-value pairs with user name as key and a UserData object as values.

A UserData objects contains attributes like userid, e-mail address and preferred locale.

Note: If the result type is not RESULT_TYPE_USERIDS, 'null' is returned.

Important: If this method is used once, the getUserData() method will return 'null' to prevent the modification of the collection normally returned with the getUserData() method.

Returns:
Map of UserData objects or null