Skip navigation links

Oracle Fusion Middleware User and Role Java API Reference for Oracle Platform Security Services
11g Release 1 (11.1.1)

E14658-01


oracle.security.idm
Class SearchParameters

java.lang.Object
  extended by oracle.security.idm.SearchParameters

All Implemented Interfaces:
java.lang.Cloneable

public class SearchParameters
extends java.lang.Object
implements java.lang.Cloneable

This class represents search parameters that need to be specified while performing searches on the identity store. These search parameters are:
1. Search filter: Search filter(SearchFilter) to be used in searching. Default is null.
2. Search identity type: Identity type to be searched. It can be SEARCH_USERS_ONLY or SEARCH_ROLES_ONLY or SEARCH_USERS_AND_ROLES. Default value is SEARCH_USERS_AND_ROLES
3. Page size: Number of results to be fetched in each page. This is only applicable if both underlying repository and the provider support paging of results. By default paging is turned off. Paging can be turned ON by specifying a positive pagesize
4. Time limit: The timelimit (milliseconds) to wait for search results before returning. If 0, it will wait for results indefinitely. Default value is 0.
5. Count limit: The maximum number of results to be returned. If it is 0 then all entries will be returned. Default value is 0.

Since:
10.1.3

Field Summary
static int DEFAULT_PAGE_SIZE
           
static int SEARCH_ROLES_ONLY
           
static int SEARCH_USERS_AND_ROLES
           
static int SEARCH_USERS_ONLY
           

 

Constructor Summary
SearchParameters()
           
SearchParameters(SearchFilter filter, int searchIdentityType)
           
SearchParameters(SearchFilter filter, int searchIdentityType, int pagesz)
           
SearchParameters(SearchFilter filter, int searchIdentityType, int pagesz, int countLimit, int timeLimit)
           

 

Method Summary
 java.lang.Object clone()
           
 int getCountLimit()
           
 SearchFilter getFilter()
           
 int getPageSize()
           
 int getSearchIdentityType()
           
 int getTimeLimit()
           
 void setCountLimit(int countLimit)
          Maximum number of search results to be returned
 void setFilter(SearchFilter filter)
           
 void setPageSize(int size)
           
 void setSearchIdentityType(int searchIdentityType)
           
 void setTimeLimit(int timeLimit)
          Time limit for searching (milli seconds)

 

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

 

Field Detail

SEARCH_ROLES_ONLY

public static final int SEARCH_ROLES_ONLY
See Also:
Constant Field Values

SEARCH_USERS_ONLY

public static final int SEARCH_USERS_ONLY
See Also:
Constant Field Values

SEARCH_USERS_AND_ROLES

public static final int SEARCH_USERS_AND_ROLES
See Also:
Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE
See Also:
Constant Field Values

Constructor Detail

SearchParameters

public SearchParameters()

SearchParameters

public SearchParameters(SearchFilter filter,
                        int searchIdentityType)

SearchParameters

public SearchParameters(SearchFilter filter,
                        int searchIdentityType,
                        int pagesz)

SearchParameters

public SearchParameters(SearchFilter filter,
                        int searchIdentityType,
                        int pagesz,
                        int countLimit,
                        int timeLimit)

Method Detail

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

getFilter

public SearchFilter getFilter()

setFilter

public void setFilter(SearchFilter filter)

getSearchIdentityType

public int getSearchIdentityType()

setSearchIdentityType

public void setSearchIdentityType(int searchIdentityType)

getPageSize

public int getPageSize()

setPageSize

public void setPageSize(int size)

getCountLimit

public int getCountLimit()

setCountLimit

public void setCountLimit(int countLimit)
Maximum number of search results to be returned

getTimeLimit

public int getTimeLimit()

setTimeLimit

public void setTimeLimit(int timeLimit)
Time limit for searching (milli seconds)

Skip navigation links

Oracle Fusion Middleware User and Role Java API Reference for Oracle Platform Security Services
11g Release 1 (11.1.1)

E14658-01


Copyright © 2005, 2009, Oracle. All rights reserved.