| Package | com.adobe.idp.um.api.infomodel |
| Class | public class GenericSearchFilter |
| Inheritance | GenericSearchFilter  Object |
| Method | Defined By | ||
|---|---|---|---|
Default constructor. | GenericSearchFilter | ||
int getResultsMax() Retrieves the maximum number of results. | GenericSearchFilter | ||
int getResultsOffset() Retrieves the offset index. | GenericSearchFilter | ||
Iterator getSearches() For internal use only. | GenericSearchFilter | ||
int getSearchType(Object searchKey) For internal use only. | GenericSearchFilter | ||
Object getSearchVal(Object searchKey) For internal use only. | GenericSearchFilter | ||
Object getSortField() Retrieves the sorting field. | GenericSearchFilter | ||
boolean isSearch(Object searchKey) For internal use only. | GenericSearchFilter | ||
boolean isSortAscending() Determines whether the sorting results will occur in ascending order. | GenericSearchFilter | ||
void setResultsMax(int resultsMax) Sets the total number of desired results. | GenericSearchFilter | ||
void setResultsOffset(int resultsOffset) Sets the offset index. | GenericSearchFilter | ||
void setSort(Object sortField, boolean sortAscending) Sets the sort order of the returned results. | GenericSearchFilter | ||
void setSortAscending(boolean sortAscending) Sets the sort order of the returned results. | GenericSearchFilter | ||
void setSortField(Object sortField) Set the field name. | GenericSearchFilter | ||
| GenericSearchFilter | () |
public GenericSearchFilter()Default constructor. By default, this filter will limit results to 10 instances.
| getResultsMax | () |
public int getResultsMax()Retrieves the maximum number of results.
Returns| The maximum number of results. |
| getResultsOffset | () |
public int getResultsOffset()Retrieves the offset index.
Returns| The offset index. |
| getSearches | () |
public Iterator getSearches()For internal use only.
Returns| getSearchType | () |
public int getSearchType(Object searchKey)For internal use only.
Parameters
searchKey |
| getSearchVal | () |
public Object getSearchVal(Object searchKey)For internal use only.
Parameters
searchKey |
| getSortField | () |
public Object getSortField()Retrieves the sorting field.
Returns| The sorting field. |
| isSearch | () |
public boolean isSearch(Object searchKey)For internal use only.
Parameters
searchKey |
| isSortAscending | () |
public boolean isSortAscending()Determines whether the sorting results will occur in ascending order.
Returnstrue if the sorting results will occur in ascending order, false otherwise. |
| setResultsMax | () |
public void setResultsMax(int resultsMax)Sets the total number of desired results. This is likely to be limited by the database, so you are advised to use values from 1 to 1000. The default value is 10.
Parameters
resultsMax |
| setResultsOffset | () |
public void setResultsOffset(int resultsOffset)Sets the offset index. This method is used for pagination in the user interface.
Parameters
resultsOffset |
| setSort | () |
public void setSort(Object sortField, boolean sortAscending)Sets the sort order of the returned results.
Parameters
sortField — A constant object. See, for example, SORT_* in PrincipalSearchFilter. | |
sortAscending — Determines whether the sorting results will occur in ascending order. |
| setSortAscending | () |
public void setSortAscending(boolean sortAscending)Sets the sort order of the returned results.
Parameters
sortAscending — Determines whether the sorting results will occur in ascending order. |
| setSortField | () |
public void setSortField(Object sortField)Set the field name. It should be one of the SORT_* in PrincipalSearchFilter
Parameters
sortField — A constant object. See, for example, SORT_* in PrincipalSearchFilter. |
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/um/api/infomodel/GenericSearchFilter.html