com.appiancorp.suiteapi.personalization

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, LocalStringId, java.io.Serializable

public class UserSearch
extends UserProfile

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:

Serialized Form

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

Constructors

Constructor and Description
UserSearch()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getGroupId() Gets the group ID
java.lang.String	getGroupName() Gets the group name
java.lang.Integer	getOperatorCustomField1() Gets the operator to be applied to custom field 1
java.lang.Integer	getOperatorCustomField10() Gets the operator to be applied to custom field 10
java.lang.Integer	getOperatorCustomField2() Gets the operator to be applied to custom field 2
java.lang.Integer	getOperatorCustomField3() Gets the operator to be applied to custom field 3
java.lang.Integer	getOperatorCustomField4() Gets the operator to be applied to custom field 4
java.lang.Integer	getOperatorCustomField5() Gets the operator to be applied to custom field 5
java.lang.Integer	getOperatorCustomField6() Gets the operator to be applied to custom field 6
java.lang.Integer	getOperatorCustomField7() Gets the operator to be applied to custom field 7
java.lang.Integer	getOperatorCustomField8() Gets the operator to be applied to custom field 8
java.lang.Integer	getOperatorCustomField9() Gets the operator to be applied to custom field 9
java.lang.Integer	getOperatorDisplayName() Gets the operator to be applied to the display name.
java.lang.Integer	getOperatorEmail() Gets the operator to be applied to the email.
java.lang.Integer	getOperatorFirstName() Gets the operator to be applied to the first name.
java.lang.Integer	getOperatorGroupName() Gets the operator to be applied to the group name
java.lang.Integer	getOperatorLastName() Gets the operator to be applied to the last name.
java.lang.Integer	getOperatorMiddleName() Gets the operator to be applied to the middle name.
java.lang.Integer	getOperatorSocialSecurityNumber() Gets the operator to be applied to the social security number.
java.lang.Integer	getOperatorSupervisorName() Gets the operator to be applied to the supervisor name
java.lang.Integer	getOperatorTitleName() Gets the operator to be applied to the title name
java.lang.Integer	getOperatorUsername() Gets the operator to be applied to the username.
void	setGroupId(java.lang.Long groupId_) Sets the group ID
void	setGroupName(java.lang.String groupName_) Sets the group name
void	setOperatorCustomField1(java.lang.Integer operatorCustomField1_) Sets the operator to be applied to custom field 1
void	setOperatorCustomField10(java.lang.Integer operatorCustomField10_) Sets the operator to be applied to custom field 10
void	setOperatorCustomField2(java.lang.Integer operatorCustomField2_) Sets the operator to be applied to custom field 2
void	setOperatorCustomField3(java.lang.Integer operatorCustomField3_) Sets the operator to be applied to custom field 3
void	setOperatorCustomField4(java.lang.Integer operatorCustomField4_) Sets the operator to be applied to custom field 4
void	setOperatorCustomField5(java.lang.Integer operatorCustomField5_) Sets the operator to be applied to custom field 5
void	setOperatorCustomField6(java.lang.Integer operatorCustomField6_) Sets the operator to be applied to custom field 6
void	setOperatorCustomField7(java.lang.Integer operatorCustomField7_) Sets the operator to be applied to custom field 7
void	setOperatorCustomField8(java.lang.Integer operatorCustomField8_) Sets the operator to be applied to custom field 8
void	setOperatorCustomField9(java.lang.Integer operatorCustomField9_) Sets the operator to be applied to custom field 9
void	setOperatorDisplayName(java.lang.Integer operatorDisplayName_) Sets the operator to be applied to the display name
void	setOperatorEmail(java.lang.Integer operatorEmail_) Sets the operator to be applied to the email
void	setOperatorFirstName(java.lang.Integer operatorFirstName_) Sets the operator to be applied to the first name
void	setOperatorGroupName(java.lang.Integer operatorGroupName_) Sets the operator to be applied to the group name
void	setOperatorLastName(java.lang.Integer operatorLastName_) Sets the operator to be applied to the last name
void	setOperatorMiddleName(java.lang.Integer operatorMiddleName_) Sets the operator to be applied to the middle name
void	setOperatorSocialSecurityNumber(java.lang.Integer operatorSocialSecurityNumber_) Sets the operator to be applied to the social security number
void	setOperatorSupervisorName(java.lang.Integer operatorSupervisorName_) Sets the operator to be applied to the supervisor name
void	setOperatorTitleName(java.lang.Integer operatorTitleName_) Sets the operator to be applied to the title name
void	setOperatorUsername(java.lang.Integer operatorUsername_) Sets the operator to be applied to the username

Methods 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UserSearch

public UserSearch()

Method Detail

getOperatorUsername

public java.lang.Integer getOperatorUsername()

Gets the operator to be applied to the username.

Returns:

the operator

setOperatorUsername

public void setOperatorUsername(java.lang.Integer operatorUsername_)

Sets the operator to be applied to the username

Parameters:

operatorUsername_ - the operator

getOperatorFirstName

public java.lang.Integer getOperatorFirstName()

Gets the operator to be applied to the first name.

Returns:

the operator

setOperatorFirstName

public void setOperatorFirstName(java.lang.Integer operatorFirstName_)

Sets the operator to be applied to the first name

Parameters:

operatorFirstName_ - the operator

getOperatorMiddleName

public java.lang.Integer getOperatorMiddleName()

Gets the operator to be applied to the middle name.

Returns:

the operator

setOperatorMiddleName

public void setOperatorMiddleName(java.lang.Integer operatorMiddleName_)

Sets the operator to be applied to the middle name

Parameters:

operatorMiddleName_ - the operator

getOperatorLastName

public java.lang.Integer getOperatorLastName()

Gets the operator to be applied to the last name.

Returns:

the operator

setOperatorLastName

public void setOperatorLastName(java.lang.Integer operatorLastName_)

Sets the operator to be applied to the last name

Parameters:

operatorLastName_ - the operator

getOperatorDisplayName

public java.lang.Integer getOperatorDisplayName()

Gets the operator to be applied to the display name.

Returns:

the operator

setOperatorDisplayName

public void setOperatorDisplayName(java.lang.Integer operatorDisplayName_)

Sets the operator to be applied to the display name

Parameters:

operatorDisplayName_ - the operator

getOperatorEmail

public java.lang.Integer getOperatorEmail()

Gets the operator to be applied to the email.

Returns:

the operator

setOperatorEmail

public void setOperatorEmail(java.lang.Integer operatorEmail_)

Sets the operator to be applied to the email

Parameters:

operatorEmail_ - the operator

getOperatorSocialSecurityNumber

public java.lang.Integer getOperatorSocialSecurityNumber()

Gets the operator to be applied to the social security number.

Returns:

the operator

setOperatorSocialSecurityNumber

public void setOperatorSocialSecurityNumber(java.lang.Integer operatorSocialSecurityNumber_)

Sets the operator to be applied to the social security number

Parameters:

operatorSocialSecurityNumber_ - the operator

getGroupId

public java.lang.Long getGroupId()

Gets the group ID

Returns:

the group ID.

setGroupId

public void setGroupId(java.lang.Long groupId_)

Sets the group ID

Parameters:

groupId_ - the group ID

getGroupName

public java.lang.String getGroupName()

Gets the group name

Returns:

the group name.

setGroupName

public void setGroupName(java.lang.String groupName_)

Sets the group name

Parameters:

groupName_ - the group name

getOperatorCustomField1

public java.lang.Integer getOperatorCustomField1()

Gets the operator to be applied to custom field 1

Returns:

the operator

setOperatorCustomField1

public void setOperatorCustomField1(java.lang.Integer operatorCustomField1_)

Sets the operator to be applied to custom field 1

Parameters:

operatorCustomField1_ - the operator

getOperatorCustomField10

public java.lang.Integer getOperatorCustomField10()

Gets the operator to be applied to custom field 10

Returns:

the operator

setOperatorCustomField10

public void setOperatorCustomField10(java.lang.Integer operatorCustomField10_)

Sets the operator to be applied to custom field 10

Parameters:

operatorCustomField10_ - the operator

getOperatorCustomField2

public java.lang.Integer getOperatorCustomField2()

Gets the operator to be applied to custom field 2

Returns:

the operator

setOperatorCustomField2

public void setOperatorCustomField2(java.lang.Integer operatorCustomField2_)

Sets the operator to be applied to custom field 2

Parameters:

operatorCustomField2_ - the operator

getOperatorCustomField3

public java.lang.Integer getOperatorCustomField3()

Gets the operator to be applied to custom field 3

Returns:

the operator

setOperatorCustomField3

public void setOperatorCustomField3(java.lang.Integer operatorCustomField3_)

Sets the operator to be applied to custom field 3

Parameters:

operatorCustomField3_ - the operator

getOperatorCustomField4

public java.lang.Integer getOperatorCustomField4()

Gets the operator to be applied to custom field 4

Returns:

the operator

setOperatorCustomField4

public void setOperatorCustomField4(java.lang.Integer operatorCustomField4_)

Sets the operator to be applied to custom field 4

Parameters:

operatorCustomField4_ - the operator

getOperatorCustomField5

public java.lang.Integer getOperatorCustomField5()

Gets the operator to be applied to custom field 5

Returns:

the operator

setOperatorCustomField5

public void setOperatorCustomField5(java.lang.Integer operatorCustomField5_)

Sets the operator to be applied to custom field 5

Parameters:

operatorCustomField5_ - the operator

getOperatorCustomField6

public java.lang.Integer getOperatorCustomField6()

Gets the operator to be applied to custom field 6

Returns:

the operator

setOperatorCustomField6

public void setOperatorCustomField6(java.lang.Integer operatorCustomField6_)

Sets the operator to be applied to custom field 6

Parameters:

operatorCustomField6_ - the operator

getOperatorCustomField7

public java.lang.Integer getOperatorCustomField7()

Gets the operator to be applied to custom field 7

Returns:

the operator

setOperatorCustomField7

public void setOperatorCustomField7(java.lang.Integer operatorCustomField7_)

Sets the operator to be applied to custom field 7

Parameters:

operatorCustomField7_ - the operator

getOperatorCustomField8

public java.lang.Integer getOperatorCustomField8()

Gets the operator to be applied to custom field 8

Returns:

the operator

setOperatorCustomField8

public void setOperatorCustomField8(java.lang.Integer operatorCustomField8_)

Sets the operator to be applied to custom field 8

Parameters:

operatorCustomField8_ - the operator

getOperatorCustomField9

public java.lang.Integer getOperatorCustomField9()

Gets the operator to be applied to custom field 9

Returns:

the operator

setOperatorCustomField9

public void setOperatorCustomField9(java.lang.Integer operatorCustomField9_)

Sets the operator to be applied to custom field 9

Parameters:

operatorCustomField9_ - the operator

getOperatorGroupName

public java.lang.Integer getOperatorGroupName()

Gets the operator to be applied to the group name

Returns:

the operator

setOperatorGroupName

public void setOperatorGroupName(java.lang.Integer operatorGroupName_)

Sets the operator to be applied to the group name

Parameters:

operatorGroupName_ - the operator

getOperatorSupervisorName

public java.lang.Integer getOperatorSupervisorName()

Gets the operator to be applied to the supervisor name

Returns:

the operator

setOperatorSupervisorName

public void setOperatorSupervisorName(java.lang.Integer operatorSupervisorName_)

Sets the operator to be applied to the supervisor name

Parameters:

operatorSupervisorName_ - the operator

getOperatorTitleName

public java.lang.Integer getOperatorTitleName()

Gets the operator to be applied to the title name

Returns:

the operator

setOperatorTitleName

public void setOperatorTitleName(java.lang.Integer operatorTitleName_)

Sets the operator to be applied to the title name

Parameters:

operatorTitleName_ - the operator