|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
---|
static final java.lang.String COPYRIGHT
static final int RESULT_TYPE_NOBODY
static final int RESULT_TYPE_EVERYBODY
static final int RESULT_TYPE_USERIDS
static final int RESULT_TYPE_GROUPIDS
Method Detail |
---|
int getResultType()
Possible values are:
java.lang.String[] getGroupIDs()
Note: Currrently, the maximum array size is 1.
com.ibm.bpe.api.UTCDate getValidUntilDate()
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.
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.
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |