public class SearchOptions extends ReadOptions
ReadOptions
containing options for entity search operation. Search options include Locale, Requested Attributes, Sort attributes, page size and page position.ReadOptions.SearchScope
ALL_LOCALES
Constructor and Description |
---|
SearchOptions() |
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
|
getIdentityDomainName, getLocale, getRequestedAttrs, getSearchBase, getSearchScope, getTimeLimit, isSearchBaseAbsolute, isStaticMembershipOnly, setGroupMembershipType, setIdentityDomainName, setLocale, setLocale, setRequestedAttrs, setSearchBase, setSearchBase, setSearchScope, setTimeLimit
getAuthUser, getParameter, getParameters, setAuthUser, setAuthUser, setParameter
public void setSortAttrs(java.lang.String[] sortAttrs)
sortAttrs
- array of sort attributespublic java.lang.String[] getSortAttrs()
public void setSortOrder(boolean ascendingOrder)
ascendingOrder
- If true then entries are arranged in ascending order; otherwise descending orderpublic boolean getSortOrder()
public void setPageSize(int pageSize)
pageSize
- page sizepublic int getPageSize()
public void setRequestedPage(int requestedPage)
requestedPage
- page positionpublic int getRequestedPage()
public void setRequestedEntities(int startPos, int endPos) throws InvalidAttributesException
startPos
- start position. Valid values are 0 and aboveendPos
- end position. Valid values are -1 or 0 and above. -1 indicates to return all entities after startPosInvalidAttributesException
- If startPos/endPos is invalid or endPos is less than startPospublic int getStartPos()
public int getEndPos()
public void setSizeLimit(int sizeLimit)
sizeLimit
- maximum number of entities to be returnedpublic int getSizeLimit()
public SearchOptions clone()
clone
in class ReadOptions