Class UserSearch
java.lang.Object
com.appiancorp.suiteapi.personalization.UserBase
com.appiancorp.suiteapi.personalization.User
com.appiancorp.suiteapi.personalization.UserProfile
com.appiancorp.suiteapi.personalization.UserSearch
- All Implemented Interfaces:
com.appiancorp.asl3.servicefw.connect.ASLIdentity
,com.appiancorp.services.ASLIdentity
,LocalStringId
,Serializable
This represents the User search object.
The UserSearch
object should be populated with the user
fields to be searched on, and the criteria to be used in performing the
search. For example, the UserSearch
object might have the
username
field set to "john.doe", the lastName
fields set to "Doe", the operatorUsername
field set to
Operator.EQUALS
and the operatorLastName
field
set to Operator.ENDS_WITH
. A call to
UserService.findUsers(UserSearch, boolean)
with this UserSearch
object will return all users
whose username is "john.doe", and whose last name ends with "Doe".
See Operator
for valid operator values.
- See Also:
-
Field Summary
Fields inherited from class com.appiancorp.suiteapi.personalization.UserProfile
SORT_BY_ADDRESS1, SORT_BY_ADDRESS2, SORT_BY_ADDRESS3, SORT_BY_CITY, SORT_BY_COUNTRY, SORT_BY_CREATED, SORT_BY_CUSTOMFIELD1, SORT_BY_CUSTOMFIELD10, SORT_BY_CUSTOMFIELD2, SORT_BY_CUSTOMFIELD3, SORT_BY_CUSTOMFIELD4, SORT_BY_CUSTOMFIELD5, SORT_BY_CUSTOMFIELD6, SORT_BY_CUSTOMFIELD7, SORT_BY_CUSTOMFIELD8, SORT_BY_CUSTOMFIELD9, SORT_BY_LASTMODIFIED, SORT_BY_PHONEHOME, SORT_BY_PHONEMOBILE, SORT_BY_PHONEOFFICE, SORT_BY_PROVINCE, SORT_BY_STATE, SORT_BY_SUPERVISORNAME, SORT_BY_TITLE_ID, SORT_BY_TITLENAME, SORT_BY_ZIPCODE, USER_TYPE_BASIC, USER_TYPE_SYS_ADMIN
Fields inherited from class com.appiancorp.suiteapi.personalization.User
SORT_BY_ID, SORT_BY_PASSWORD, SORT_BY_USERNAME, USER_ROLE_ADMINISTRATOR, USER_ROLE_CREATOR, USER_ROLE_MEMBER, USER_ROLE_VIEWER
Fields inherited from class com.appiancorp.suiteapi.personalization.UserBase
SORT_BY_DISPLAYNAME, SORT_BY_EMAIL, SORT_BY_FIRSTNAME, SORT_BY_LASTNAME, SORT_BY_MIDDLENAME, SORT_BY_SOCIALSECURITYNUMBER, STATUS_ACTIVE, STATUS_DEACTIVATED
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the group IDGets the group nameGets the operator to be applied to custom field 1Gets the operator to be applied to custom field 10Gets the operator to be applied to custom field 2Gets the operator to be applied to custom field 3Gets the operator to be applied to custom field 4Gets the operator to be applied to custom field 5Gets the operator to be applied to custom field 6Gets the operator to be applied to custom field 7Gets the operator to be applied to custom field 8Gets the operator to be applied to custom field 9Gets the operator to be applied to the display name.Gets the operator to be applied to the email.Gets the operator to be applied to the first name.Gets the operator to be applied to the group nameGets the operator to be applied to the last name.Gets the operator to be applied to the middle name.Gets the operator to be applied to the social security number.Gets the operator to be applied to the supervisor nameGets the operator to be applied to the title nameGets the operator to be applied to the username.void
setGroupId
(Long groupId_) Sets the group IDvoid
setGroupName
(String groupName_) Sets the group namevoid
setOperatorCustomField1
(Integer operatorCustomField1_) Sets the operator to be applied to custom field 1void
setOperatorCustomField10
(Integer operatorCustomField10_) Sets the operator to be applied to custom field 10void
setOperatorCustomField2
(Integer operatorCustomField2_) Sets the operator to be applied to custom field 2void
setOperatorCustomField3
(Integer operatorCustomField3_) Sets the operator to be applied to custom field 3void
setOperatorCustomField4
(Integer operatorCustomField4_) Sets the operator to be applied to custom field 4void
setOperatorCustomField5
(Integer operatorCustomField5_) Sets the operator to be applied to custom field 5void
setOperatorCustomField6
(Integer operatorCustomField6_) Sets the operator to be applied to custom field 6void
setOperatorCustomField7
(Integer operatorCustomField7_) Sets the operator to be applied to custom field 7void
setOperatorCustomField8
(Integer operatorCustomField8_) Sets the operator to be applied to custom field 8void
setOperatorCustomField9
(Integer operatorCustomField9_) Sets the operator to be applied to custom field 9void
setOperatorDisplayName
(Integer operatorDisplayName_) Sets the operator to be applied to the display namevoid
setOperatorEmail
(Integer operatorEmail_) Sets the operator to be applied to the emailvoid
setOperatorFirstName
(Integer operatorFirstName_) Sets the operator to be applied to the first namevoid
setOperatorGroupName
(Integer operatorGroupName_) Sets the operator to be applied to the group namevoid
setOperatorLastName
(Integer operatorLastName_) Sets the operator to be applied to the last namevoid
setOperatorMiddleName
(Integer operatorMiddleName_) Sets the operator to be applied to the middle namevoid
setOperatorSocialSecurityNumber
(Integer operatorSocialSecurityNumber_) Sets the operator to be applied to the social security numbervoid
setOperatorSupervisorName
(Integer operatorSupervisorName_) Sets the operator to be applied to the supervisor namevoid
setOperatorTitleName
(Integer operatorTitleName_) Sets the operator to be applied to the title namevoid
setOperatorUsername
(Integer operatorUsername_) Sets the operator to be applied to the usernameMethods inherited from class com.appiancorp.suiteapi.personalization.UserProfile
getAddress1, getAddress2, getAddress3, getBlurb, getCity, getConfirmPassword, getCountry, getCreated, getCustomField1, getCustomField10, getCustomField2, getCustomField3, getCustomField4, getCustomField5, getCustomField6, getCustomField7, getCustomField8, getCustomField9, getLastModified, getLocale, getPhoneHome, getPhoneMobile, getPhoneOffice, getProcessModelerPreferredView, getProvince, getState, getSupervisorName, getTimeZone, getTitleId, getTitleName, getUserTypeId, getUserTypeName, getZipCode, setAddress1, setAddress2, setAddress3, setBlurb, setCity, setConfirmPassword, setCountry, setCreated, setCustomField1, setCustomField10, setCustomField2, setCustomField3, setCustomField4, setCustomField5, setCustomField6, setCustomField7, setCustomField8, setCustomField9, setLastModified, setLocale, setPhoneHome, setPhoneMobile, setPhoneOffice, setProcessModelerPreferredView, setProvince, setState, setSupervisorName, setTimeZone, setTitleId, setTitleName, setUserTypeId, setUserTypeName, setZipCode, toString
Methods inherited from class com.appiancorp.suiteapi.personalization.User
getId, getIdentifier, getIdentity, getPassword, getPasswordModified, getStringId, getUsernames, getUserPassword, getUuid, isTemporaryPassword, isUserLocked, setId, setPassword, setPasswordModified, setStringId, setTemporaryPassword, setUserLocked, setUserPassword, setUuid
Methods inherited from class com.appiancorp.suiteapi.personalization.UserBase
getDisplayName, getEmail, getFavorite, getFirstName, getLastName, getMiddleName, getSocialSecurityNumber, getStatus, getUsername, setDisplayName, setEmail, setFavorite, setFirstName, setLastName, setMiddleName, setSocialSecurityNumber, setStatus, setUsername
-
Constructor Details
-
UserSearch
public UserSearch()
-
-
Method Details
-
getOperatorUsername
Gets the operator to be applied to the username.- Returns:
- the operator
-
setOperatorUsername
Sets the operator to be applied to the username- Parameters:
operatorUsername_
- the operator
-
getOperatorFirstName
Gets the operator to be applied to the first name.- Returns:
- the operator
-
setOperatorFirstName
Sets the operator to be applied to the first name- Parameters:
operatorFirstName_
- the operator
-
getOperatorMiddleName
Gets the operator to be applied to the middle name.- Returns:
- the operator
-
setOperatorMiddleName
Sets the operator to be applied to the middle name- Parameters:
operatorMiddleName_
- the operator
-
getOperatorLastName
Gets the operator to be applied to the last name.- Returns:
- the operator
-
setOperatorLastName
Sets the operator to be applied to the last name- Parameters:
operatorLastName_
- the operator
-
getOperatorDisplayName
Gets the operator to be applied to the display name.- Returns:
- the operator
-
setOperatorDisplayName
Sets the operator to be applied to the display name- Parameters:
operatorDisplayName_
- the operator
-
getOperatorEmail
Gets the operator to be applied to the email.- Returns:
- the operator
-
setOperatorEmail
Sets the operator to be applied to the email- Parameters:
operatorEmail_
- the operator
-
getOperatorSocialSecurityNumber
Gets the operator to be applied to the social security number.- Returns:
- the operator
-
setOperatorSocialSecurityNumber
Sets the operator to be applied to the social security number- Parameters:
operatorSocialSecurityNumber_
- the operator
-
getGroupId
Gets the group ID- Returns:
- the group ID.
-
setGroupId
Sets the group ID- Parameters:
groupId_
- the group ID
-
getGroupName
Gets the group name- Returns:
- the group name.
-
setGroupName
Sets the group name- Parameters:
groupName_
- the group name
-
getOperatorCustomField1
Gets the operator to be applied to custom field 1- Returns:
- the operator
-
setOperatorCustomField1
Sets the operator to be applied to custom field 1- Parameters:
operatorCustomField1_
- the operator
-
getOperatorCustomField10
Gets the operator to be applied to custom field 10- Returns:
- the operator
-
setOperatorCustomField10
Sets the operator to be applied to custom field 10- Parameters:
operatorCustomField10_
- the operator
-
getOperatorCustomField2
Gets the operator to be applied to custom field 2- Returns:
- the operator
-
setOperatorCustomField2
Sets the operator to be applied to custom field 2- Parameters:
operatorCustomField2_
- the operator
-
getOperatorCustomField3
Gets the operator to be applied to custom field 3- Returns:
- the operator
-
setOperatorCustomField3
Sets the operator to be applied to custom field 3- Parameters:
operatorCustomField3_
- the operator
-
getOperatorCustomField4
Gets the operator to be applied to custom field 4- Returns:
- the operator
-
setOperatorCustomField4
Sets the operator to be applied to custom field 4- Parameters:
operatorCustomField4_
- the operator
-
getOperatorCustomField5
Gets the operator to be applied to custom field 5- Returns:
- the operator
-
setOperatorCustomField5
Sets the operator to be applied to custom field 5- Parameters:
operatorCustomField5_
- the operator
-
getOperatorCustomField6
Gets the operator to be applied to custom field 6- Returns:
- the operator
-
setOperatorCustomField6
Sets the operator to be applied to custom field 6- Parameters:
operatorCustomField6_
- the operator
-
getOperatorCustomField7
Gets the operator to be applied to custom field 7- Returns:
- the operator
-
setOperatorCustomField7
Sets the operator to be applied to custom field 7- Parameters:
operatorCustomField7_
- the operator
-
getOperatorCustomField8
Gets the operator to be applied to custom field 8- Returns:
- the operator
-
setOperatorCustomField8
Sets the operator to be applied to custom field 8- Parameters:
operatorCustomField8_
- the operator
-
getOperatorCustomField9
Gets the operator to be applied to custom field 9- Returns:
- the operator
-
setOperatorCustomField9
Sets the operator to be applied to custom field 9- Parameters:
operatorCustomField9_
- the operator
-
getOperatorGroupName
Gets the operator to be applied to the group name- Returns:
- the operator
-
setOperatorGroupName
Sets the operator to be applied to the group name- Parameters:
operatorGroupName_
- the operator
-
getOperatorSupervisorName
Gets the operator to be applied to the supervisor name- Returns:
- the operator
-
setOperatorSupervisorName
Sets the operator to be applied to the supervisor name- Parameters:
operatorSupervisorName_
- the operator
-
getOperatorTitleName
Gets the operator to be applied to the title name- Returns:
- the operator
-
setOperatorTitleName
Sets the operator to be applied to the title name- Parameters:
operatorTitleName_
- the operator
-