Skip navigation links


com.essbase.eas.admin.defs
Class FindRequest

java.lang.Object
  extended by com.essbase.eas.admin.defs.FindRequest


public class FindRequest
extends java.lang.Object

Find an external user


Field Summary
static int ALL_USERS
          Find all users
static int BY_EMAIL
          Find a user by e-mail address
static int BY_NAME
          Find a user by first name and/or last name
static int BY_USER
          Find a user by user name
static int GROUP_BY_NAME
          Find a group by name

 

Constructor Summary
FindRequest()
          A find request is input to the search

 

Method Summary
 java.lang.String getFindEmail()
          Return the e-mail search string
 java.lang.String getFindFirstName()
          Return the first name search string
 java.lang.String getFindGroup()
          Return the group search string
 java.lang.String getFindLastName()
          Return the last name search parameter
 int getFindMethod()
          Return the find method
 java.lang.String getFindUser()
          Return the user search string
 boolean getSearchAllProviders()
          Return the all providers search status
 boolean isValid()
          Different searches have different criteria.
 void setFindEmail(java.lang.String searchForEmail)
          Set the e-mail search string
 void setFindFirstName(java.lang.String searchForFirstName)
          Set the first name search string
 void setFindGroup(java.lang.String searchForGroups)
          Set the group search string
 void setFindLastName(java.lang.String searchForLastName)
          Set the last name search string
 void setFindMethod(int method)
          Set the find method for searching for a user
 void setFindUser(java.lang.String searchForUsers)
          Set the user name to search for
 void setSearchAllProviders(boolean searchAll)
          Search all providers

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

BY_NAME

public static final int BY_NAME
Find a user by first name and/or last name
See Also:
Constant Field Values

BY_EMAIL

public static final int BY_EMAIL
Find a user by e-mail address
See Also:
Constant Field Values

BY_USER

public static final int BY_USER
Find a user by user name
See Also:
Constant Field Values

ALL_USERS

public static final int ALL_USERS
Find all users
See Also:
Constant Field Values

GROUP_BY_NAME

public static final int GROUP_BY_NAME
Find a group by name
See Also:
Constant Field Values

Constructor Detail

FindRequest

public FindRequest()
A find request is input to the search

Method Detail

setFindUser

public void setFindUser(java.lang.String searchForUsers)
Set the user name to search for
Parameters:
the - search string

getFindUser

public java.lang.String getFindUser()
Return the user search string
Returns:

setFindGroup

public void setFindGroup(java.lang.String searchForGroups)
Set the group search string
Parameters:
the - search string

getFindGroup

public java.lang.String getFindGroup()
Return the group search string
Returns:
the search string

setFindFirstName

public void setFindFirstName(java.lang.String searchForFirstName)
Set the first name search string
Parameters:
the - search string

getFindFirstName

public java.lang.String getFindFirstName()
Return the first name search string
Returns:
the search string

setFindLastName

public void setFindLastName(java.lang.String searchForLastName)
Set the last name search string
Parameters:
the - search string

getFindLastName

public java.lang.String getFindLastName()
Return the last name search parameter
Returns:
the last name

setFindEmail

public void setFindEmail(java.lang.String searchForEmail)
Set the e-mail search string
Parameters:
e-mail - search string

getFindEmail

public java.lang.String getFindEmail()
Return the e-mail search string
Returns:
e-mail search

setSearchAllProviders

public void setSearchAllProviders(boolean searchAll)
Search all providers
Parameters:
true - if all providers are to be searched

getSearchAllProviders

public boolean getSearchAllProviders()
Return the all providers search status
Returns:
true if all providers are being searched

setFindMethod

public void setFindMethod(int method)
Set the find method for searching for a user
Parameters:
method - is BY_EMAIL,BY_NAME, or GROUP_BY_NAME

getFindMethod

public int getFindMethod()
Return the find method
Returns:
eitherBY_EMAIL,BY_NAME, or GROUP_BY_NAME

isValid

public boolean isValid()
Different searches have different criteria.

A search for users must begin with a alphanumeric character and can have a single wildcard which must match 1 character. An example is l* or le*. Additional wildcard characters are truncated

A search by name must be an exact match

A search by e-mail must also be an exact match

Returns:
true if valid

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.