com.adobe.idp.um.api.infomodel
Class GenericSearchFilter

java.lang.Object
  com.adobe.idp.um.api.infomodel.GenericSearchFilter

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GroupMembershipSearchFilter, PermissionSearchFilter, PrincipalSearchFilter, ResourceTypeSearchFilter, RoleMembershipSearchFilter, RoleSearchFilter

public abstract class GenericSearchFilter
extends java.lang.Object
implements java.io.Serializable

Repressents a generic search filter class.

See Also:

Serialized Form

Constructor Summary

GenericSearchFilter()
The default GenericSearchFilter constructor.

Method Summary

int	getResultsMax() Retrieves the maximum number of results.
int	getResultsOffset() Retrieves the offset index.
java.util.Iterator	getSearches() For internal use only.
int	getSearchType(java.lang.Object searchKey) For internal use only.
java.lang.Object	getSearchVal(java.lang.Object searchKey) For internal use only.
java.lang.Object	getSortField() Retrieves the sorting field.
boolean	isSearch(java.lang.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(java.lang.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(java.lang.Object sortField) Set the field name.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericSearchFilter

public GenericSearchFilter()

The default GenericSearchFilter constructor. By default, this filter will limit results to 10 instances.

Method Detail

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.

setResultsMax

public void setResultsMax(int resultsMax)

Sets the total number of desired results. This value is limited by the database, so you are advised to use values from 1 to 1000. The default value is 10.

Parameters:

resultsMax - An integer that represents the number of results.

setResultsOffset

public void setResultsOffset(int resultsOffset)

Sets the offset index. This method is used for pagination in the user interface.

Parameters:

resultsOffset - An integer value that represents the offset index.

setSort

public void setSort(java.lang.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.

isSortAscending

public boolean isSortAscending()

Determines whether the sorting results occur in ascending order.

Returns:

The value true if the sorting results will occur in ascending order, false otherwise.

setSortField

public void setSortField(java.lang.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.

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.

getSortField

public java.lang.Object getSortField()

Retrieves the sorting field.

Returns:

The sorting field.

isSearch

public boolean isSearch(java.lang.Object searchKey)

For internal use only.

getSearchVal

public java.lang.Object getSearchVal(java.lang.Object searchKey)

For internal use only.

getSearchType

public int getSearchType(java.lang.Object searchKey)

For internal use only.

getSearches

public java.util.Iterator getSearches()

For internal use only.