oracle.igf.ids

Class SearchOptions

java.lang.Object

oracle.igf.ids.OperationOptions

oracle.igf.ids.ReadOptions

oracle.igf.ids.SearchOptions

public class SearchOptions
extends ReadOptions

This class extends ReadOptions containing options for entity search operation. Search options include Locale, Requested Attributes, Sort attributes, page size and page position.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.igf.ids.ReadOptions

ReadOptions.SearchScope

Field Summary

Fields inherited from class oracle.igf.ids.ReadOptions

ALL_LOCALES

Constructor Summary

Constructors

Constructor and Description
SearchOptions()

Method Summary

Modifier and Type	Method and Description
SearchOptions	clone() Clones this object
int	getEndPos() Gets the end position
int	getPageSize() Gets the page size
int	getRequestedPage() Gets the page position
int	getSizeLimit() Gets the size limit
java.lang.String[]	getSortAttrs() Gets the array of sort attributes
boolean	getSortOrder() Gets the sort order ascending/descending
int	getStartPos() Gets the start position
void	setPageSize(int pageSize) Sets the pagesize to be used while searching the entities in the repository.
void	setRequestedEntities(int startPos, int endPos) Sets the requested entities range to be returned
void	setRequestedPage(int requestedPage) Sets the page position, the entities in the page to be returned
void	setSizeLimit(int sizeLimit) Sets the size limit, maximum number of entities to be returned by the search method
void	setSortAttrs(java.lang.String[] sortAttrs) Sets the array of attributes on which the search results to be sorted.
void	setSortOrder(boolean ascendingOrder) Sets ascending/descending order of sort attributes in which entries to be arranged

Methods inherited from class oracle.igf.ids.ReadOptions

getIdentityDomainName, getLocale, getRequestedAttrs, getSearchBase, getSearchScope, getTimeLimit, isSearchBaseAbsolute, isStaticMembershipOnly, setGroupMembershipType, setIdentityDomainName, setLocale, setLocale, setRequestedAttrs, setSearchBase, setSearchBase, setSearchScope, setTimeLimit

Methods inherited from class oracle.igf.ids.OperationOptions

getAuthUser, getParameter, getParameters, setAuthUser, setAuthUser, setParameter

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchOptions

public SearchOptions()

Method Detail

setSortAttrs

public void setSortAttrs(java.lang.String[] sortAttrs)

Sets the array of attributes on which the search results to be sorted. Sorting of the results by these attributes is not guaranteed. Results are sorted only if the backend repository supports sorting. Relationship results are not sorted.

Parameters:

sortAttrs - array of sort attributes

getSortAttrs

public java.lang.String[] getSortAttrs()

Gets the array of sort attributes

Returns:

array of sort attributes

setSortOrder

public void setSortOrder(boolean ascendingOrder)

Sets ascending/descending order of sort attributes in which entries to be arranged

Parameters:

ascendingOrder - If true then entries are arranged in ascending order; otherwise descending order

getSortOrder

public boolean getSortOrder()

Gets the sort order ascending/descending

Returns:

sort order true - ascending order; false - descending order

setPageSize

public void setPageSize(int pageSize)

Sets the pagesize to be used while searching the entities in the repository. If either the pagesize is 0 or the backend does not support paging then the search method may not return all the entities matching the search filter.

Parameters:

pageSize - page size

getPageSize

public int getPageSize()

Gets the page size

Returns:

pagesize

setRequestedPage

public void setRequestedPage(int requestedPage)

Sets the page position, the entities in the page to be returned

Parameters:

requestedPage - page position

getRequestedPage

public int getRequestedPage()

Gets the page position

Returns:

page position

setRequestedEntities

public void setRequestedEntities(int startPos,
                                 int endPos)
                          throws InvalidAttributesException

Sets the requested entities range to be returned

Parameters:

startPos - start position. Valid values are 0 and above

endPos - end position. Valid values are -1 or 0 and above. -1 indicates to return all entities after startPos

Throws:

InvalidAttributesException - If startPos/endPos is invalid or endPos is less than startPos

getStartPos

public int getStartPos()

Gets the start position

Returns:

start position

getEndPos

public int getEndPos()

Gets the end position

Returns:

end position

setSizeLimit

public void setSizeLimit(int sizeLimit)

Sets the size limit, maximum number of entities to be returned by the search method

Parameters:

sizeLimit - maximum number of entities to be returned

getSizeLimit

public int getSizeLimit()

Gets the size limit

Returns:

size limit

clone

public SearchOptions clone()

Clones this object

Overrides:

clone in class ReadOptions

Returns:

cloned object