|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.imaging.Search.Node
oracle.imaging.Search.Condition
public static class Search.Condition
The Condition class defines a leaf of a Search$Node
. This class defines the following objects:
Search$Operator
) for a SearchCondition object.Search$Condition$Property
The valid properties the condition clause may use to search on.It allows the use of either field definition from an application or the use of predefined properties Search.Condition.Property
. The Search condition combines the field definition or property with a condition searchOperator and a search value. If a parametername is specified, then the condition's search value may be updated dynamically from a map of parameter values.
This object is a leaf object and therefore is a terminal point in the search expression.
Nested Class Summary | |
---|---|
static class |
Search.Condition.Property This is an enumeration of the valid Imaging Attributes that may be used in a search. |
Nested classes/interfaces inherited from class oracle.imaging.Search.Node |
---|
Search.Node.NodePk |
Field Summary |
---|
Fields inherited from class oracle.imaging.Search.Node |
---|
leftId, leftOperand, rightId, rightOperand, search, searchNodeId, searchOperator |
Constructor Summary | |
---|---|
Search.Condition() Default constructor required for JAXB serialization. |
|
Search.Condition(NameId fieldDefinition, Search.Operator operator, SearchValue searchValue) Convienence Constructor. |
|
Search.Condition(NameId fieldDefinition, Search.Operator operator, java.lang.String parameterName) Convienence Constructor. |
|
Search.Condition(Search.Condition condition) Convienence Constructor. |
Method Summary | |
---|---|
NameId |
getFieldDefinition() Gets the field identifier ( NameId ) this condition will search for. |
Search.Node |
getLeftOperand() This method is overridden to return null because the the SearchCondition class is a leaf in the tree structure. |
java.lang.String |
getParameterName() Gets the name of the parameter. |
Search.Condition.Property |
getProperty() Gets the Search.Condition.Property that the condition will search for. |
Search.Node |
getRightOperand() This method is overridden to return null because the the SearchCondition class is a leaf in the tree structure. |
SearchValue |
getSearchValue() Gets the SearchValue that the condition is to use in the search. |
boolean |
isField() Flag to determine if the condition is a field style condition. |
boolean |
isLeaf() Flag to determine if the object is a leaf or a node. |
boolean |
isProperty() Flag to determine if the condition is a property style condition. |
boolean |
isValidOperator() Determines if the Search$Operator is contained in the list of valid operators for the SearchCondition class. |
void |
setFieldDefinition(NameId aFieldId) Sets the field identifier ( NameId ) this condition will search for. |
void |
setParameterName(java.lang.String newparameterName) Sets the name of the parameter. |
void |
setProperty(Search.Condition.Property aProperty) Sets the Search.Condition.Property this condition will search for. |
void |
setSearchValue(SearchValue aSearchValue) Sets the SearchValue to use for this condition. |
Methods inherited from class oracle.imaging.Search.Node |
---|
getAlwaysDisplayParentheses, getSearchOperator, setAlwaysDisplayParentheses, setLeftOperand, setRightOperand, setSearchOperator |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Search.Condition()
public Search.Condition(Search.Condition condition)
condition
-public Search.Condition(NameId fieldDefinition, Search.Operator operator, java.lang.String parameterName)
fieldDefinition
- The identifier for the field.operator
- The logical search searchOperatorparameterName
- The name key to the parameter witihn the parameter mappublic Search.Condition(NameId fieldDefinition, Search.Operator operator, SearchValue searchValue)
fieldDefinition
- The identifier for the field.operator
- The logical search searchOperatorsearchValue
- The search value used in this search condition.Method Detail |
---|
public NameId getFieldDefinition()
NameId
) this condition will search for. This attribute is mutually exclusive with the property
attribute. This attribute is used in conjunction with the application
atrribute to uniquely identify the field. If the fieldDefinition
is null, then an empty (invalid) value is returned.public Search.Node getLeftOperand()
SearchCondition
class is a leaf in the tree structure. It has no children to return.getLeftOperand
in class Search.Node
public java.lang.String getParameterName()
SearchArgument
, then this attribute will not be null
.public Search.Condition.Property getProperty()
Search.Condition.Property
that the condition will search for.public Search.Node getRightOperand()
SearchCondition
class is a leaf in the tree structure. It has no children to return.getRightOperand
in class Search.Node
public SearchValue getSearchValue()
SearchValue
that the condition is to use in the search.public final boolean isField()
true
if the fieldDefinition attribute is a valid NameId.public final boolean isLeaf()
isLeaf
in class Search.Node
true
- A SearchCondition
is a leaf.public final boolean isProperty()
true
if the property attribute is not null
.public boolean isValidOperator()
Search$Operator
is contained in the list of valid operators for the SearchCondition class.isValidOperator
in class Search.Node
true
if the opeartor is contained within the list of valid operators.public void setFieldDefinition(NameId aFieldId)
NameId
) this condition will search for. This attribute is mutually exclusive with the property
attribute. If the identifier is non-null, then the property
attribute will be set to null
. This attribute is used in conjunction with the application
atrribute to uniquely identify the field.aFieldId
- the identifier for the field.public void setParameterName(java.lang.String newparameterName)
SearchArgument
, then this attribute will not be null
.newparameterName
- the name key to the parameter witihn the parameter map.public void setProperty(Search.Condition.Property aProperty)
Search.Condition.Property
this condition will search for. This attribute is mutually exclusive with the fieldDefinition
attribute. If the property is non-null, then the fieldDefinition
attribute will be set to null
.aProperty
- the property this condition will test against.public void setSearchValue(SearchValue aSearchValue)
SearchValue
to use for this condition.aSearchValue
- The search value used in this search condition.
|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |