com.ibm.task.spi
Interface StaffQueryResult


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
static java.lang.String COPYRIGHT
           
static int RESULT_TYPE_EVERYBODY
          States that everybody is qualifying.
static int RESULT_TYPE_GROUPIDS
          States that a set of qualifying group IDs is returned.
static int RESULT_TYPE_NOBODY
          States that no one is qualifying.
static int RESULT_TYPE_USERIDS
          States that a set of qualifying user IDs is returned.
 
Method Summary
 java.lang.String[] getGroupIDs()
          This method returns the set of group IDs when the result type indicates that group IDs are returned.
 int getResultType()
          This method returns an indicator that describes the content of the staff result set.
 java.util.Collection getUserData()
          This method returns a collection of UserData objects.
 java.util.Map getUserDataMap()
          This method returns a Map containing key-value pairs with user name as key and a UserData object as values.
 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

COPYRIGHT

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

RESULT_TYPE_NOBODY

static final int RESULT_TYPE_NOBODY
States that no one is qualifying.

See Also:
Constant Field Values

RESULT_TYPE_EVERYBODY

static final int RESULT_TYPE_EVERYBODY
States that everybody is qualifying.

See Also:
Constant Field Values

RESULT_TYPE_USERIDS

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:
Constant Field Values

RESULT_TYPE_GROUPIDS

static final int RESULT_TYPE_GROUPIDS
States that a set of qualifying group IDs is returned.

See Also:
Constant Field Values
Method Detail

getResultType

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

Possible values are:

Returns:
The staff result set indicator.

getGroupIDs

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

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

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

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