|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.idp.um.api.infomodel.GenericSearchFilter
public abstract class GenericSearchFilter
Repressents a generic search filter class.
Constructor Summary | |
---|---|
GenericSearchFilter()
The default GenericSearchFilter constructor. |
Method Summary | |
---|---|
int |
getResultsMax()
Retrieves the maximum number of results. |
int |
getResultsOffset()
Retrieves the offset index. |
Iterator |
getSearches()
For internal use only. |
int |
getSearchType(Object searchKey)
For internal use only. |
Object |
getSearchVal(Object searchKey)
For internal use only. |
Object |
getSortField()
Retrieves the sorting field. |
boolean |
isSearch(Object searchKey)
For internal use only. |
boolean |
isSortAscending()
Determines whether the sorting results occur in ascending order. |
void |
setResultsMax(int resultsMax)
Sets the total number of desired results. |
void |
setResultsOffset(int resultsOffset)
Sets the offset index. |
void |
setSort(Object sortField,
boolean sortAscending)
Sets the sort order of the returned results. |
void |
setSortAscending(boolean sortAscending)
Sets the sort order of the returned results. |
void |
setSortField(Object sortField)
Set the field name. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GenericSearchFilter()
GenericSearchFilter
constructor.
By default, this filter will limit results to 10 instances.
Method Detail |
---|
public int getResultsMax()
public int getResultsOffset()
public void setResultsMax(int resultsMax)
resultsMax
- An integer that represents the number of results.public void setResultsOffset(int resultsOffset)
resultsOffset
- An integer value that represents the offset index.public void setSort(Object sortField, boolean sortAscending)
sortField
- A constant object. See, for example, SORT_*
in PrincipalSearchFilter
.sortAscending
- Determines whether the sorting results will occur in ascending order.public boolean isSortAscending()
true
if the sorting results will occur in ascending order, false
otherwise.public void setSortField(Object sortField)
SORT_*
in PrincipalSearchFilter
.
sortField
- A constant object. See, for example, SORT_*
in PrincipalSearchFilter
.public void setSortAscending(boolean sortAscending)
sortAscending
- Determines whether the sorting results will occur in ascending order.public Object getSortField()
public boolean isSearch(Object searchKey)
public Object getSearchVal(Object searchKey)
public int getSearchType(Object searchKey)
public Iterator getSearches()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |