oracle.jbo.common.types
Interface FindCriteria

All Known Subinterfaces:

ChildFindCriteria, ChildFindCriteria, FindCriteria

All Known Implementing Classes:

ChildFindCriteriaImpl, FindCriteriaImpl, FindCriteriaImpl

public interface FindCriteria

Since:

11g Release 1 (11.1.1)

Method Summary

java.util.List	getChildFindCriteria() Gets the list of child view objects from which to retrieve data.
boolean	getExcludeAttribute() Gets the flag that indicates whether to include or exclude specified attributes.
int	getFetchSize() Gets the maximum number of rows to retrieve.
int	getFetchStart() Gets the zero-based row index to start with.
ViewCriteria	getFilter() Gets additional runtime search condition.
java.util.List	getFindAttribute() Gets the list of attributes (view attributes and link accessors) to retrieve.
SortOrder	getSortOrder() Gets the query result sort order.
void	setChildFindCriteria(java.util.List value) Sets the list of child view objects from which to retrieve data.
void	setExcludeAttribute(boolean value) Sets the flag that indicates whether to include or exclude specified attributes.
void	setFetchSize(int value) Sets the maximum number of rows to retrieve.
void	setFetchStart(int value) Sets the zero-based row index to start with.
void	setFilter(ViewCriteria value) Sets additional runtime search condition.
void	setFindAttribute(java.util.List value) Sets the list of attributes (view attributes and link accessors) to retrieve.
void	setSortOrder(SortOrder value) Sets the query result sort order.

Method Detail

getFetchStart

int getFetchStart()

Gets the zero-based row index to start with.

Returns:

starting row index.

setFetchStart

void setFetchStart(int value)

Sets the zero-based row index to start with. The default is 0 (first row).

Parameters:

value - starting row index

getFetchSize

int getFetchSize()

Gets the maximum number of rows to retrieve.

Returns:

maximum number of rows to retrieve.

setFetchSize

void setFetchSize(int value)

Sets the maximum number of rows to retrieve. A fetch size of -1 gets all rows found after the start row. If fetch size is greater than the number of remaining rows, only the remaining rows are returned.

Parameters:

value - maximum number of rows to retrieve

getFilter

ViewCriteria getFilter()

Gets additional runtime search condition.

Returns:

additional runtime search condition.

setFilter

void setFilter(ViewCriteria value)

Sets additional runtime search condition.

Parameters:

value - additional runtime search condition

getSortOrder

SortOrder getSortOrder()

Gets the query result sort order.

Returns:

query result sort order.

setSortOrder

void setSortOrder(SortOrder value)

Sets the query result sort order. This consists of an ordered array of sort attributes.

Parameters:

value - query result sort order

getFindAttribute

java.util.List getFindAttribute()

Gets the list of attributes (view attributes and link accessors) to retrieve.

Returns:

list of attribute names.

setFindAttribute

void setFindAttribute(java.util.List value)

Sets the list of attributes (view attributes and link accessors) to retrieve. When none is specified, all attributes are fetched.

Parameters:

value - list of attribute names

getExcludeAttribute

boolean getExcludeAttribute()

Gets the flag that indicates whether to include or exclude specified attributes.

Returns:

exclusion flag.

setExcludeAttribute

void setExcludeAttribute(boolean value)

Sets the flag that indicates whether to include or exclude specified attributes. The default is false (include specified attributes).

Parameters:

value - exclusion flag

getChildFindCriteria

java.util.List getChildFindCriteria()

Gets the list of child view objects from which to retrieve data.

Returns:

list of child object search criteria.

setChildFindCriteria

void setChildFindCriteria(java.util.List value)

Sets the list of child view objects from which to retrieve data. When none is specified, children are fetched using the default search criteria (first row, all rows, no additional search condition, etc.).

Parameters:

value - list of child object search criteria