com.ibm.task.spi
Interface StaffQueryResult
- public interface StaffQueryResult
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
|
RESULT_TYPE_EVERYBODY
States that everybody is qualifying.
|
|
RESULT_TYPE_GROUPIDS
States that a set of qualifying group IDs is returned.
|
|
RESULT_TYPE_NOBODY
States that no one is qualifying.
|
|
RESULT_TYPE_USERIDS
States that a set of qualifying user IDs is returned.
|
|
RESULT_TYPE_USERIDS_AND_GROUPIDS
States that user and group IDs are returned.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getGroupIDs()
This method returns the set of group IDs when the result type indicates
that group IDs are returned.
|
|
getResultType()
This method returns an indicator that describes the content of the staff
result set.
|
|
getUserData()
This method returns a collection of UserData objects.
|
|
getUserDataMap()
This method returns a Map containing key-value pairs with user name as
key and a UserData object as values.
|
|
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
RESULT_TYPE_NOBODY
- static final int RESULT_TYPE_NOBODY
RESULT_TYPE_EVERYBODY
- static final int RESULT_TYPE_EVERYBODY
RESULT_TYPE_USERIDS
- static final int RESULT_TYPE_USERIDS
RESULT_TYPE_GROUPIDS
- static final int RESULT_TYPE_GROUPIDS
RESULT_TYPE_USERIDS_AND_GROUPIDS
- static final int RESULT_TYPE_USERIDS_AND_GROUPIDS
Method Detail
getResultType
- int getResultType()
Possible values are:
- RESULT_TYPE_NOBODY
- RESULT_TYPE_EVERYBODY
- RESULT_TYPE_USERIDS
- RESULT_TYPE_GROUPIDS
- RESULT_TYPE_USERIDS_AND_GROUPIDS
getGroupIDs
- java.lang.String[] getGroupIDs( )
Note: Currrently, the maximum array size is 1.
getValidUntilDate
- com.ibm.bpe.api.UTCDate getValidUntilDate( )
getUserData
- java.util.Collection getUserData( )
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.
getUserDataMap
- java.util.Map getUserDataMap()
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.