com.ibm.task.spi
Class StaffQueryResultFactory
- java.lang.Object
com.ibm.task.spi.StaffQueryResultFactory
- public class StaffQueryResultFactory
- extends java.lang.Object
Since:
6.0.2
Version:
6.1.0
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
Constructor Summary
Constructor and Description |
---|
StaffQueryResultFactory()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
newInstance()
Creates an instance of the factory.
|
newStaffQueryResult(java.util.Collection userData)
Creates a new object of StaffQueryResult by specifying a set of users.
|
|
newStaffQueryResult(java.util.Collection userData,java.lang.String[] groupIDs)
Creates a new object of StaffQueryResult by specifying a set of users
and an array of group IDs.
|
|
newStaffQueryResult(int resultType)
Creates a new object of StaffQueryResult by specifying the result type.
|
|
newStaffQueryResult(java.util.Map userDataMap)
Creates a new object of StaffQueryResult by specifying a map of users.
|
|
newStaffQueryResult(java.lang.String groupID)
Creates a new object of StaffQueryResult by specifying a group ID.
|
|
newStaffQueryResult(java.lang.String[] groupIDs)
Creates a new object of StaffQueryResult by specifying an array of group IDs.
|
|
newUserData(java.lang.String userID,java.util.Locale preferredLocale,java.lang.String eMailAddress)
Creates a new object of UserData.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail
COPYRIGHT
- public static final java.lang.String COPYRIGHT
See Also:
Constructor Detail
StaffQueryResultFactory
- public StaffQueryResultFactory( )
Method Detail
newInstance
- public static StaffQueryResultFactory newInstance( )
Creates an instance of the factory.
newStaffQueryResult
- public StaffQueryResult newStaffQueryResult( int resultType)
Creates a new object of StaffQueryResult by specifying the result type.
Parameters:
resultType
- The type of the query result. Can be RESULT_TYPE_EVERYBODY or
RESULT_TYPE_NOBODY Returns:
The created StaffQueryResult object.
newStaffQueryResult
- public StaffQueryResult newStaffQueryResult( java.util.Collection userData)
Creates a new object of StaffQueryResult by specifying a set of users.
The result type is RESULT_TYPE_USERIDS.
Parameters:
userData
- A container with UserData entries for multiple users. Returns:
The created StaffQueryResult object.
newStaffQueryResult
- public StaffQueryResult newStaffQueryResult( java.util.Map userDataMap)
Creates a new object of StaffQueryResult by specifying a map of users.
The result type is RESULT_TYPE_USERIDS.
Parameters:
userDataMap
- A map with UserData entries for multiple users. Returns:
The created StaffQueryResult object.
newStaffQueryResult
- public StaffQueryResult newStaffQueryResult( java.lang.String groupID)
Creates a new object of StaffQueryResult by specifying a group ID.
The result type is RESULT_TYPE_GROUPIDS.
Parameters:
groupID
- The ID of the user group. Returns:
The created StaffQueryResult object.
newStaffQueryResult
- public StaffQueryResult newStaffQueryResult( java.lang.String[] groupIDs)
Creates a new object of StaffQueryResult by specifying an array of group IDs.
The result type is RESULT_TYPE_GROUPIDS.
Parameters:
groupIDs
- The IDs of the user groups. Must be non-null and non-empty. Returns:
The created StaffQueryResult object.
newStaffQueryResult
- public StaffQueryResult newStaffQueryResult( java.util.Collection userData,
- java.lang.String[] groupIDs)
Creates a new object of StaffQueryResult by specifying a set of users
and an array of group IDs.
The result type is RESULT_TYPE_USERIDS_AND_GROUPIDS.
Parameters:
userData
- A container with UserData entries for multiple users. groupIDs
- The IDs of the user groups. Must be non-null and non-empty. Returns:
The created StaffQueryResult object.
newUserData
- public UserData newUserData(java.lang.String userID,
- java.util.Locale preferredLocale,
- java.lang.String eMailAddress)
Creates a new object of UserData.
Parameters:
userID
- The user ID of the user. preferredLocale
- The preferred locale of the user. Can be null. eMailAddress
- The e-mail address of the user. Can be null.