oracle.jbo.server

Interface RowFilter

All Known Implementing Classes:

EffectiveDateFilterRange, EffectiveDateFilterRangeQC, RowFilterKey, RowFilterKeyForwardOnly, RowFilterQC

public interface RowFilter

Method Summary

Modifier and Type	Method and Description
int	getParamLength() Returns the number of elements in the array of parameters that make up the row filter.
java.lang.Object[]	getParamValues() Returns the array of parameter values that make up the row filter.
int	getRowInitLength() Returns the number of elements in the array of row init values.
java.lang.Object[]	getRowInitValues() Returns the array of row init values.
ViewObjectImpl	getViewObjectImpl() Retrieves the view object association with the row filter.
java.lang.Object[]	getWhereClauseParams() Returns the array of wherel-caluse parameter values that make up the row filter.
boolean	isNull() Indicates whether this row filter represents a null filter or not.
boolean	paramQualifies(java.lang.Object[] values) Returns a flag indicating whether values is qualified by this row filter or not.
boolean	paramQualifiesWithOffset(java.lang.Object[] values, int filterOffset)
boolean	whereClauseParamQualifies(java.lang.Object[] values)

Method Detail

getViewObjectImpl

ViewObjectImpl getViewObjectImpl()

Retrieves the view object association with the row filter.

Returns:

the view object.

isNull

boolean isNull()

Indicates whether this row filter represents a null filter or not.

Returns:

flag indicating whether the row filter represents a null filter or not.

getParamLength

int getParamLength()

Returns the number of elements in the array of parameters that make up the row filter.

Returns:

the number of elements.

getParamValues

java.lang.Object[] getParamValues()

Returns the array of parameter values that make up the row filter.

The difference between getParamValues() and getWhereClauseParams() shows up when the view object binding style is BINDING_STYLE_ORACLE_NAME. In this case, getWhereClauseParams() returns an array of name-value array. getParamValues() returns only an array of values.

Returns:

the parameter value array.

getWhereClauseParams

java.lang.Object[] getWhereClauseParams()

Returns the array of wherel-caluse parameter values that make up the row filter.

The difference between getParamValues() and getWhereClauseParams() shows up when the view object binding style is BINDING_STYLE_ORACLE_NAME. In this case, getWhereClauseParams() returns an array of name-value array. getParamValues() returns only an array of values.

Returns:

the where-clause parameter array.

paramQualifies

boolean paramQualifies(java.lang.Object[] values)

Returns a flag indicating whether values is qualified by this row filter or not.

Parameters:

values - values to examine for qualification.

Returns:

a flag indicating whether it passes or not.

paramQualifiesWithOffset

boolean paramQualifiesWithOffset(java.lang.Object[] values,
                                 int filterOffset)

whereClauseParamQualifies

boolean whereClauseParamQualifies(java.lang.Object[] values)

getRowInitLength

int getRowInitLength()

Returns the number of elements in the array of row init values.

Returns:

the number of elements.

getRowInitValues

java.lang.Object[] getRowInitValues()

Returns the array of row init values.

Returns:

the row init value array.