oracle.binding.meta.criteria

Interface Criteria

All Superinterfaces:

Definition, NamedDefinition

public interface Criteria
extends NamedDefinition

This interface holds the definition of a criteria. A criteria contains predefined information to limit the selection of an accessor. Criteria are specific to the type of accessor that they belong to and cannot be applied to a different type of accessor. Each criteria contains a list of criteria rows.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Criteria.Conjunction

Field Summary

Fields inherited from interface oracle.binding.meta.Definition

TYPE_ACCESSOR, TYPE_ATTRIBUTE, TYPE_CRITERIA, TYPE_CRITERIA_ITEM, TYPE_CRITERIA_OPERATOR, TYPE_CRITERIA_ROW, TYPE_DATACONTROL, TYPE_DEFINITION, TYPE_DEFINITIONCONTEXT, TYPE_NAMED, TYPE_OPERATION, TYPE_OPERATIONRETURN, TYPE_PARAMETER, TYPE_STRUCTURE, TYPE_VARIABLE

Method Summary

Modifier and Type	Method and Description
void	addRow(CriteriaRow newRow) Allows design time tool to add a row or a nested view criteria to this view criteria.
NestedCriteriaRow	createNestedCriteriaRow(java.lang.String name, Criteria criteria) Create a new row that contains a nested criteria.
SimpleRow	createSimpleRow(java.lang.String name) Create a new simple row that does not contain a nested row.
java.util.List	getPropertyListOfValues(java.lang.String propertyName) Returns a list of all valid values that is allowed in the given property.
java.util.List	getRows() Return the ordered list of Criteria rows, each of which is either a nested view criteria or a row that consists of one or more items.
boolean	removeRow(CriteriaRow row) Removes the specified row from the criteria.
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a row property.
boolean	supportsNestedViewCriteria() Whether nested view criteria are supported.
void	validate() Validates this criteria.

Methods inherited from interface oracle.binding.meta.NamedDefinition

getDefinitionParent, getFullName, getName, getProperties, getProperty

Methods inherited from interface oracle.binding.meta.Definition

getDefinitionType

Method Detail

getRows

java.util.List getRows()

Return the ordered list of Criteria rows, each of which is either a nested view criteria or a row that consists of one or more items.

Returns:

A list of CriteriaRow objects that this view criteria is made up of.

addRow

void addRow(CriteriaRow newRow)

Allows design time tool to add a row or a nested view criteria to this view criteria.

Parameters:

newRow - The row to be added to this view criteria.

removeRow

boolean removeRow(CriteriaRow row)

Removes the specified row from the criteria.

Parameters:

row - The row to be removed.

Returns:

true if the row is removed sucessfully, false if the row does not exist in the criteria, or the row is not removed sucessfully.

supportsNestedViewCriteria

boolean supportsNestedViewCriteria()

Whether nested view criteria are supported. If so, the view criteria can contain nested view criterion.

Returns:

true if nested view criteria are supported.

createSimpleRow

SimpleRow createSimpleRow(java.lang.String name)

Create a new simple row that does not contain a nested row.

Parameters:

name - The name of the criteria row to be created.

Returns:

The newly created view criteria row that can be added to a view criteria.

createNestedCriteriaRow

NestedCriteriaRow createNestedCriteriaRow(java.lang.String name,
                                          Criteria criteria)

Create a new row that contains a nested criteria. The row can later be added to a criteria.

Parameters:

name - The name of the nested criteria to be created.

criteria - the view criteria to be nested.

Returns:

The newly created nested view criteria that can be added to a view criteria.

getPropertyListOfValues

java.util.List getPropertyListOfValues(java.lang.String propertyName)

Returns a list of all valid values that is allowed in the given property.
If the given property allows any String value, this method should return null.

Parameters:

propertyName - The name of the property whose list of valid values should be returned.

Returns:

A List of String containing the valid values for the given property. Null if there is no list of valid values for the property.

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)

Sets the value of a row property.

Parameters:

name - name of the property to be set.

value - value of the property.

validate

void validate()
       throws java.lang.IllegalArgumentException

Validates this criteria. This is for use by design tools to make sure that the newly created criteria is valid.

Throws:

java.lang.IllegalArgumentException