oracle.binding.meta.criteria

Interface Item

All Superinterfaces:

Definition, NamedDefinition

All Known Subinterfaces:

NestedRowItem, SimpleItem

public interface Item
extends NamedDefinition

Parent interface for all criteria item definitions. There are 3 types of criteria items: 1. SubSelect criteria item: Contains a left operand, operator, and a right operand that is a named criteria. Items of this type should implements the SimpleItem interface. This type of item can be used for subselect queries on child/children tables and enforces restriction on a parent resultset based on criteria on the child/children tables. 2. Nested Row criteria item: Contains nested criteria rows on the same accessor. Items fo this type should implements the NestedRowItem iterface. This type of item can by use to allow nesting or bracketing of where-clause fragments. 3. Attribute Item: Contains a left operand, operator, and a right operand that can be attribute values or expressions. Items of this type should implements the SimpleItem interface. Examples of right operand expression include proper SQL fragments or expressions with wild characters * or %.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Item.ItemType constants to be returned by getItemType

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
Criteria.Conjunction	getConjunction() The conjunction to be applied to this criteria item with its immediate predecessor.
Item.ItemType	getItemType() This method indicates whether this criteria item is a Subselect criteria item, a nested row criteria item, or an attribute criteria item.
java.util.List	getPropertyListOfValues(java.lang.String propertyName) Returns a list of all valid values that is allowed in the given property.
void	setConjunction(Criteria.Conjunction conjunction) Sets the conjunction of this row.
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a row property.
void	validate() Validates this criteria item.

Methods inherited from interface oracle.binding.meta.NamedDefinition

getDefinitionParent, getFullName, getName, getProperties, getProperty

Methods inherited from interface oracle.binding.meta.Definition

getDefinitionType

Method Detail

getItemType

Item.ItemType getItemType()

This method indicates whether this criteria item is a Subselect criteria item, a nested row criteria item, or an attribute criteria item.

Returns:

A ItemType enum indicating the type of this criteria item.

getConjunction

Criteria.Conjunction getConjunction()

The conjunction to be applied to this criteria item with its immediate predecessor.

Returns:

Conjunction represented by the enum type Conjunction defined in Criteria interface.

setConjunction

void setConjunction(Criteria.Conjunction conjunction)

Sets the conjunction of this row. The conjunction will be applied to connect this row with the previous item in the criteria row. If an item is created but its conjunction is not set, the default row-level conjunction for the datacontrol is assumed.

Parameters:

conjunction - The conjunction of this row.

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 item. This is for use by design tools to make sure that the newly created criteria item is valid.

Throws:

java.lang.IllegalArgumentException