com.sap.security.api
Interface IUserSearchFilter

All Superinterfaces:

IPrincipalSearchFilter

public interface IUserSearchFilter

extends IPrincipalSearchFilter

This class acts as a container for text values to be used as a search filter when calling searchUsers(UserSearchFilter) of an IUserFactory. All attributes are intialized with null. Parameter mode in the set methods refer to the defined operators of ISearchAttribute and can have following values: ISearchAttribute.EQUALS_OPERATOR, ISearchAttribute.LIKE_OPERATOR, ISearchAttribute.GREATER_THAN_OPERATOR, ISearchAttribute.LESS_THAN_OPERATOR

Version:

1.0

Field Summary

static java.lang.String

VERSIONSTRING

Fields inherited from interface com.sap.security.api.IPrincipalSearchFilter

SEARCHMETHOD_AND, SEARCHMETHOD_OR

Method Summary

java.lang.String	getCellPhone() Get the cell phone attribute value to match in the user search
java.lang.String	getCity() Get the city attribute value to match in the user search
java.lang.String	getCompany() Get the company attribute value to match in the user search
java.lang.String	getCompanyId() Get the company id attribute value to match in the user search
java.lang.String	getCountry() Get the ISO-639 country attribute value to match in the user search
java.lang.String	getCurrency() Get the currency attribute value to match in the user search
java.lang.String	getDepartment() Get the department attribute value to match in the user search
java.lang.String	getDescription() Get the description attribute value to match in the user search
java.lang.String	getEmail() Get the email attribute value to match in the user search
java.lang.String	getFax() Get the fax attribute value to match in the user search
java.lang.String	getFirstName() Get the first name attribute value to match in the user search
java.lang.String	getJobTitle() Get the job title attribute value to match in the user search
java.lang.String	getLastName() Get the last name attribute value to match in the user search
java.util.Locale	getLocale() Get the locale attribute value to match in the user search
java.lang.String	getSalutation() Get the salutation attribute value to match in the user search
java.lang.String	getState() Get the state attribute value to match in the user search
java.lang.String	getStreet() Get the street attribute value to match in the user search
java.lang.String	getTelephone() Get the telephone attribute value to match in the user search
java.lang.String	getTitle() Get the title attribute value to match in the user search
java.lang.String	getUniqueName() Get the unique name attribute value to match in the user search
java.lang.String	getZip() Get the zip attribute value to match in the user search
void	setCellPhone(java.lang.String cellphone, int mode, boolean caseSensitive) Set the cell phone attribute value to match in the user search
void	setCity(java.lang.String city, int mode, boolean caseSensitive) Set the city attribute value to match in the user search
void	setCompany(java.lang.String company, int mode, boolean caseSensitive) Set the company attribute value to match in the user search
void	setCompanyId(java.lang.String company, int mode, boolean caseSensitive) Set the company id attribute value to match in the user search
void	setCountry(java.lang.String country, int mode, boolean caseSensitive) Set the ISO-639 country attribute value to match in the user search
void	setCurrency(java.lang.String currency, int mode, boolean caseSensitive) Set the currency attribute value to match in the user search
void	setDepartment(java.lang.String department, int mode, boolean caseSensitive) Set the department attribute value to match in the user search
void	setDescription(java.lang.String description, int mode, boolean caseSensitive) Set the description attribute value to match in the user search
void	setEmail(java.lang.String email, int mode, boolean caseSensitive) Set the email attribute value to match in the user search
void	setFax(java.lang.String fax, int mode, boolean caseSensitive) Set the fax attribute value to match in the user search
void	setFirstName(java.lang.String firstname, int mode, boolean caseSensitive) Set the first name attribute value to match in the user search
void	setJobTitle(java.lang.String jobtitle, int mode, boolean caseSensitive) Set the job title attribute value to match in the user search
void	setLastName(java.lang.String lastname, int mode, boolean caseSensitive) Set the last name attribute value to match in the user search
void	setLocale(java.util.Locale locale, int mode, boolean caseSensitive) Set the locale attribute value to match in the user search
void	setSalutation(java.lang.String salutation, int mode, boolean caseSensitive) Set the salutation attribute value to match in the user search
void	setState(java.lang.String state, int mode, boolean caseSensitive) Set the state attribute value to match in the user search
void	setStreet(java.lang.String street, int mode, boolean caseSensitive) Set the street attribute value to match in the user search
void	setTelephone(java.lang.String telephone, int mode, boolean caseSensitive) Set the telephone attribute value to match in the user search
void	setTitle(java.lang.String title, int mode, boolean caseSensitive) Get the title attribute value to match in the user search
void	setUniqueName(java.lang.String uniqueName, int mode, boolean caseSensitive) Set the unique name attribute value to match in the user search
void	setZip(java.lang.String zip, int mode, boolean caseSensitive) Set the zip attribute value to match in the user search

Methods inherited from interface com.sap.security.api.IPrincipalSearchFilter

clear, getDisplayName, getElementAt, getElementSize, getMaxSearchResultSize, getSearchAttributeNames, getSearchAttributes, getSearchElementAt, getSearchMethod, getSearchNamespaces, getSearchOperator, getSearchPrincipalType, isEmpty, setDirectChild, setDisplayName, setMaxSearchResultSize, setSearchAttribute, setSearchMethod

Field Detail

VERSIONSTRING

public static final java.lang.String VERSIONSTRING

Method Detail

getTitle

public java.lang.String getTitle()

Get the title attribute value to match in the user search

Returns:

The value of the title field or null if the field is not set

getSalutation

public java.lang.String getSalutation()

Get the salutation attribute value to match in the user search

Returns:

The value of the salutation field or null if the field is not set

getJobTitle

public java.lang.String getJobTitle()

Get the job title attribute value to match in the user search

Returns:

The value of the job title field or null if the field is not set

getDepartment

public java.lang.String getDepartment()

Get the department attribute value to match in the user search

Returns:

The value of the department field or null if the field is not set

getFirstName

public java.lang.String getFirstName()

Get the first name attribute value to match in the user search

Returns:

The value of the first name field or null if the field is not set

getLastName

public java.lang.String getLastName()

Get the last name attribute value to match in the user search

Returns:

The value of the last name field or null if the field is not set

getStreet

public java.lang.String getStreet()

Get the street attribute value to match in the user search

Returns:

The value of the street field or null if the field is not set

getCity

public java.lang.String getCity()

Get the city attribute value to match in the user search

Returns:

The value of the city field or null if the field is not set

getZip

public java.lang.String getZip()

Get the zip attribute value to match in the user search

Returns:

The value of the zip field or null if the field is not set

getState

public java.lang.String getState()

Get the state attribute value to match in the user search

Returns:

The value of the state field or null if the field is not set

getCountry

public java.lang.String getCountry()

Get the ISO-639 country attribute value to match in the user search

Returns:

The value of the country field or null if the field is not set

getCurrency

public java.lang.String getCurrency()

Get the currency attribute value to match in the user search

Returns:

The value of the currency field or null if the field is not set

getTelephone

public java.lang.String getTelephone()

Get the telephone attribute value to match in the user search

Returns:

The value of the telephone field or null if the field is not set

getCellPhone

public java.lang.String getCellPhone()

Get the cell phone attribute value to match in the user search

Returns:

The value of the cell phone field or null if the field is not set

getFax

public java.lang.String getFax()

Get the fax attribute value to match in the user search

Returns:

The value of the fax field or null if the field is not set

getEmail

public java.lang.String getEmail()

Get the email attribute value to match in the user search

Returns:

The value of the email field or null if the field is not set

getCompanyId

public java.lang.String getCompanyId()

Get the company id attribute value to match in the user search

Returns:

The value of the company id field or null if the field is not set

getCompany

public java.lang.String getCompany()

Get the company attribute value to match in the user search

Returns:

The value of the company id field or null if the field is not set

setTitle

public void setTitle(java.lang.String title,
                     int mode,
                     boolean caseSensitive)

Get the title attribute value to match in the user search

Parameters:

title: - The value which is searched in the title field of the user

mode. - Use the constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

Returns:

The value of the title field

setSalutation

public void setSalutation(java.lang.String salutation,
                          int mode,
                          boolean caseSensitive)

Set the salutation attribute value to match in the user search

Parameters:

salutation - The value which is searched in the salutation field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setJobTitle

public void setJobTitle(java.lang.String jobtitle,
                        int mode,
                        boolean caseSensitive)

Set the job title attribute value to match in the user search

Parameters:

jobtitle - The value which is searched in the job title field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setDepartment

public void setDepartment(java.lang.String department,
                          int mode,
                          boolean caseSensitive)

Set the department attribute value to match in the user search

Parameters:

department - The value which is searched in the department field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setFirstName

public void setFirstName(java.lang.String firstname,
                         int mode,
                         boolean caseSensitive)

Set the first name attribute value to match in the user search

Parameters:

firstname - The value which is searched in the first name field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setLastName

public void setLastName(java.lang.String lastname,
                        int mode,
                        boolean caseSensitive)

Set the last name attribute value to match in the user search

Parameters:

lastname - The value which is searched in the last name field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setStreet

public void setStreet(java.lang.String street,
                      int mode,
                      boolean caseSensitive)

Set the street attribute value to match in the user search

Parameters:

street - The value which is searched in the street field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setCity

public void setCity(java.lang.String city,
                    int mode,
                    boolean caseSensitive)

Set the city attribute value to match in the user search

Parameters:

city - The value which is searched in the city field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setZip

public void setZip(java.lang.String zip,
                   int mode,
                   boolean caseSensitive)

Set the zip attribute value to match in the user search

Parameters:

zip - The value which is searched in the zip field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setState

public void setState(java.lang.String state,
                     int mode,
                     boolean caseSensitive)

Set the state attribute value to match in the user search

Parameters:

state - The value which is searched in the state field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setCountry

public void setCountry(java.lang.String country,
                       int mode,
                       boolean caseSensitive)

Set the ISO-639 country attribute value to match in the user search

Parameters:

ISO-639 - country The value which is searched in the ISO-639 country field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setCurrency

public void setCurrency(java.lang.String currency,
                        int mode,
                        boolean caseSensitive)

Set the currency attribute value to match in the user search

Parameters:

currency - The value which is searched in the currency field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setTelephone

public void setTelephone(java.lang.String telephone,
                         int mode,
                         boolean caseSensitive)

Set the telephone attribute value to match in the user search

Parameters:

telephone - The value which is searched in the telephone field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setCellPhone

public void setCellPhone(java.lang.String cellphone,
                         int mode,
                         boolean caseSensitive)

Set the cell phone attribute value to match in the user search

Parameters:

cell - phone The value which is searched in the cell phone field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setFax

public void setFax(java.lang.String fax,
                   int mode,
                   boolean caseSensitive)

Set the fax attribute value to match in the user search

Parameters:

fax - The value which is searched in the fax field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setEmail

public void setEmail(java.lang.String email,
                     int mode,
                     boolean caseSensitive)

Set the email attribute value to match in the user search

Parameters:

email - The value which is searched in the email field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setCompany

public void setCompany(java.lang.String company,
                       int mode,
                       boolean caseSensitive)

Set the company attribute value to match in the user search

Parameters:

state - The value which is searched in the company field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setCompanyId

public void setCompanyId(java.lang.String company,
                         int mode,
                         boolean caseSensitive)

Set the company id attribute value to match in the user search

Parameters:

state - The value which is searched in the company field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

getLocale

public java.util.Locale getLocale()

Get the locale attribute value to match in the user search

Returns:

The value of the locale field or null if the field is not set

setLocale

public void setLocale(java.util.Locale locale,
                      int mode,
                      boolean caseSensitive)

Set the locale attribute value to match in the user search

Parameters:

locale - The value which is searched in the locale field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

setDescription

public void setDescription(java.lang.String description,
                           int mode,
                           boolean caseSensitive)

Set the description attribute value to match in the user search

Parameters:

description - The value which is searched in the description field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

getDescription

public java.lang.String getDescription()

Get the description attribute value to match in the user search

Returns:

The value of the description field or null if the field is not set

setUniqueName

public void setUniqueName(java.lang.String uniqueName,
                          int mode,
                          boolean caseSensitive)

Set the unique name attribute value to match in the user search

Parameters:

uniquename - The value which is searched in the unique name field of users

mode. - The constants defined in ISearchAttribute

caseSensitive - Set case sensitivity

getUniqueName

public java.lang.String getUniqueName()

Get the unique name attribute value to match in the user search

Returns:

The value of the unique name field or null if the field is not set