public class StaffQueryResultFactory
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
Constructor and Description |
---|
StaffQueryResultFactory() |
Modifier and Type | Method and Description |
---|---|
static StaffQueryResultFactory |
newInstance()
Creates an instance of the factory.
|
StaffQueryResult |
newStaffQueryResult(java.util.Collection userData)
Creates a new object of StaffQueryResult by specifying a set of users.
|
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.
|
StaffQueryResult |
newStaffQueryResult(int resultType)
Creates a new object of StaffQueryResult by specifying the result type.
|
StaffQueryResult |
newStaffQueryResult(java.util.Map userDataMap)
Creates a new object of StaffQueryResult by specifying a map of users.
|
StaffQueryResult |
newStaffQueryResult(java.lang.String groupID)
Creates a new object of StaffQueryResult by specifying a group ID.
|
StaffQueryResult |
newStaffQueryResult(java.lang.String[] groupIDs)
Creates a new object of StaffQueryResult by specifying an array of group IDs.
|
UserData |
newUserData(java.lang.String userID,
java.util.Locale preferredLocale,
java.lang.String eMailAddress)
Creates a new object of UserData.
|
public static final java.lang.String COPYRIGHT
public static StaffQueryResultFactory newInstance()
public StaffQueryResult newStaffQueryResult(int resultType)
resultType
- The type of the query result. Can be RESULT_TYPE_EVERYBODY or
RESULT_TYPE_NOBODYpublic StaffQueryResult newStaffQueryResult(java.util.Collection userData)
userData
- A container with UserData entries for multiple users.public StaffQueryResult newStaffQueryResult(java.util.Map userDataMap)
userDataMap
- A map with UserData entries for multiple users.public StaffQueryResult newStaffQueryResult(java.lang.String groupID)
groupID
- The ID of the user group.public StaffQueryResult newStaffQueryResult(java.lang.String[] groupIDs)
groupIDs
- The IDs of the user groups. Must be non-null and non-empty.public StaffQueryResult newStaffQueryResult(java.util.Collection userData, java.lang.String[] groupIDs)
userData
- A container with UserData entries for multiple users.groupIDs
- The IDs of the user groups. Must be non-null and non-empty.public UserData newUserData(java.lang.String userID, java.util.Locale preferredLocale, java.lang.String eMailAddress)
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.