edu.vt.middleware.ed.query
Interface SearchCriteria

All Known Implementing Classes:

AbstractSearchCriteria, DirectSearchCriteria, EntitlementSearchCriteria, GroupSearchCriteria, PersonSearchCriteria, ServiceSearchCriteria

public interface SearchCriteria

Contains methods common to all search criteria.

Version:

$Revision: 7995 $ $Date: 2008-06-24 14:38:59 -0400 (Tue, 24 Jun 2008) $

Author:

Daniel Fisher

Field Summary

static int	DEFAULT_MAX_RESULTS Default number of maximum results
static int	SINGLE_RESULT Default number for single result
static int	UNLIMITED_RESULTS Constant that can be used with setMaxResults(int) to specify unlimited results.
static int	WS_MAX_RESULTS Maximum results for web service calls

Method Summary

String	getEjbQL() Returns the EJB-QL for this search criteria.
int	getFirstResult() This returns the position of the first result to return for this criteria.
boolean	getLoadLazyProperties() This returns whether lazy properties should be loaded for all search results.
int	getMaxResults() This returns the maximum number of results to return for this criteria.
Long	getUid() This returns the uid for the search object.
boolean	isEmpty() Returns whether any search criteria exists.
void	setFirstResult(int i) This sets the position of the first result to return for this criteria.
void	setLoadLazyProperties(boolean b) This sets whether to lazy properties should be loaded for all search results.
void	setMaxResults(int i) This sets the maximum number of results to return for this criteria.
void	setUid(Long l) This sets the uid for the search object.

Field Detail

UNLIMITED_RESULTS

static final int UNLIMITED_RESULTS

Constant that can be used with setMaxResults(int) to specify unlimited results.

See Also:

Constant Field Values

SINGLE_RESULT

static final int SINGLE_RESULT

Default number for single result

See Also:

Constant Field Values

DEFAULT_MAX_RESULTS

static final int DEFAULT_MAX_RESULTS

Default number of maximum results

See Also:

Constant Field Values

WS_MAX_RESULTS

static final int WS_MAX_RESULTS

Maximum results for web service calls

See Also:

Constant Field Values

Method Detail

getUid

Long getUid()

This returns the uid for the search object. Returns null if no uid has been set.

Returns:

Long

setUid

void setUid(Long l)

This sets the uid for the search object.

Parameters:

l - Long

getMaxResults

int getMaxResults()

This returns the maximum number of results to return for this criteria.

Returns:

int

setMaxResults

void setMaxResults(int i)

This sets the maximum number of results to return for this criteria.

Parameters:

i - int

getFirstResult

int getFirstResult()

This returns the position of the first result to return for this criteria.

Returns:

int

setFirstResult

void setFirstResult(int i)

This sets the position of the first result to return for this criteria.

Parameters:

i - int

getLoadLazyProperties

boolean getLoadLazyProperties()

This returns whether lazy properties should be loaded for all search results. Default value is true.

Returns:

boolean

setLoadLazyProperties

void setLoadLazyProperties(boolean b)

This sets whether to lazy properties should be loaded for all search results.

Parameters:

b - boolean

getEjbQL

String getEjbQL()

Returns the EJB-QL for this search criteria.

Returns:

String

isEmpty

boolean isEmpty()

Returns whether any search criteria exists.

Returns:

boolean