|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.adf.view.rich.model.Criterion
oracle.adf.view.rich.model.AttributeCriterion
public abstract class AttributeCriterion
An AttributeCriterion contains information specific to a search field that is based off an attribute as defined by an AttributeDescriptor.
A search field contains various parts such as a label, a list of operators that are relevant to its attribute's type, one or more value fields (date or number support searching between ranges for e.g.).
This interface defines a contract that a model implementor needs to support to facilitate displaying such a search field.
Nested Class Summary | |
---|---|
static class |
AttributeCriterion.RequiredType Defines the possible values for the required attribute of a Criterion |
Constructor Summary | |
---|---|
AttributeCriterion() |
Method Summary | |
---|---|
abstract AttributeDescriptor |
getAttribute() Returns the AttributeDescriptor instance that this Criterion is based on. |
AttributeDescriptor.ComponentType |
getComponentType(AttributeDescriptor.Operator operator) Returns the component type to be used to render the criterion's value field(s) based on the operator that is passed in. |
boolean |
getMatchCase() getMatchCase |
java.util.List<? extends java.lang.Object> |
getModelList() Returns a list of model objects to be used by the operands of a criterion. |
abstract AttributeDescriptor.Operator |
getOperator() Gets the default operator to use for the search field. |
abstract java.util.Map<java.lang.String,AttributeDescriptor.Operator> |
getOperators() Gets a map of operators supported by a criterion. |
AttributeCriterion.RequiredType |
getRequired() |
abstract java.util.List<? extends java.lang.Object> |
getValues() Returns a list of values to be used for a search field. |
boolean |
hasDependentCriterion(int index) Returns true if this criterion instance has dependent criterion. |
abstract boolean |
isRemovable() Whether the criterion can be removed. |
void |
setMatchCase(boolean matchCase) setMatchCase |
abstract void |
setOperator(AttributeDescriptor.Operator operator) Sets a value for the operator to use for a search field when performing a query. |
void |
setRequired(AttributeCriterion.RequiredType required) setRequired |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AttributeCriterion()
Method Detail |
---|
public abstract AttributeDescriptor getAttribute()
public java.util.List<? extends java.lang.Object> getModelList()
For e.g. in EL notation, modelList[0] should return the model object for the first operand; modelList[1] should return the model object for the second operand etc. The type of the model object returned is based on the component type of the attribute. See below for details.
public AttributeDescriptor.ComponentType getComponentType(AttributeDescriptor.Operator operator)
operator
- the Operator instance for which the ComponentType needs to be determined.public boolean hasDependentCriterion(int index)
index
- value indicating the position of the criterion's operand.public abstract AttributeDescriptor.Operator getOperator()
public abstract java.util.Map<java.lang.String,AttributeDescriptor.Operator> getOperators()
public abstract java.util.List<? extends java.lang.Object> getValues()
This is used when search fields display more than one value component for entry. For e.g., when searching between a range of values it is often required to present 2 entry fields for users to enter the range.For boolean data type if the componentType happens to be selectBooleanCheckbox, a List with a single element containing a Boolean value is expected.
public abstract boolean isRemovable()
public abstract void setOperator(AttributeDescriptor.Operator operator)
operator
- an OperatorTypepublic void setMatchCase(boolean matchCase)
matchCase
- Sets a value for matchCase for a search field.public boolean getMatchCase()
public void setRequired(AttributeCriterion.RequiredType required)
required
- sets a value for the required condition of a search field. A search field can either be required or selectively required with other fields or could be optional "required" - mandatory search field "selectively required" - selectively required with other fields "not required" - non mandatory search fieldpublic AttributeCriterion.RequiredType getRequired()
|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |