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 containing user attributes, that is, userid, e-mail address and preferred locale.
 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

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

RESULT_TYPE_NOBODY

public static final int RESULT_TYPE_NOBODY
States that no one is qualifying.

See Also:
Constant Field Values

RESULT_TYPE_EVERYBODY

public static final int RESULT_TYPE_EVERYBODY
States that everybody is qualifying.

See Also:
Constant Field Values

RESULT_TYPE_USERIDS

public 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

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

See Also:
Constant Field Values
Method Detail

getResultType

public 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

public 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

public 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

public java.util.Collection getUserData()
This method returns a collection of UserData objects containing user attributes, that is, userid, e-mail address and preferred locale. The size and order of the collection corresponds with the userID array. The collection contains entries of type Map that contain the user attributes as name-value pairs. The attribute names are standardized in this interface, but could also be extended by convention between staff resolution and consumer.

Returns:
A collection of UserData objects.