|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.0.0) E17488-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.adf.view.rich.model.QueryDescriptor
public abstract class QueryDescriptor
A QueryDescriptor describes a saved search by providing Criterion objects (used to render search fields; by providing an ability to add remove Criterion objects. In addition, it also provides methods to change the definition of a QueryDescriptor, such as its name, UI hints and mode.
Nested Class Summary | |
---|---|
static class |
QueryDescriptor.QueryMode Identifies the search mode for the saved search. |
Field Summary | |
---|---|
static java.lang.String |
UIHINT_AUTO_EXECUTE Whether the saved search related to this QueryDescriptor should execute the query when it is selected on the search panel. |
static java.lang.String |
UIHINT_DEFAULT Whether the saved search should be loaded by default when the user first visits the search panel during a session. |
static java.lang.String |
UIHINT_IMMUTABLE Whether the QueryDescriptor object can be updated. |
static java.lang.String |
UIHINT_MODE The mode used (QueryMode.BASIC|QueryMode.ADVANCED) |
static java.lang.String |
UIHINT_NAME The display name to use for the saved search. |
static java.lang.String |
UIHINT_RESULTS_COMPONENT_ID The id of the results component whose layout needs to be persisted. |
static java.lang.String |
UIHINT_SAVE_RESULTS_LAYOUT Whether the saved search related to this QueryDescriptor should persist the layout of the results component (to a persistent store). |
static java.lang.String |
UIHINT_SHOW_IN_LIST Whether the saved search related to this QueryDescriptor should appear in the "Saved Searches" choice list in the main search panel. |
Constructor Summary | |
---|---|
QueryDescriptor() |
Method Summary | |
---|---|
abstract void |
addCriterion(java.lang.String name) Adds a criterion to the current QueryDescriptor. |
abstract void |
changeMode(QueryDescriptor.QueryMode mode) Called when the QueryMode changes. |
abstract ConjunctionCriterion |
getConjunctionCriterion() Returns the ConjunctionCriterion object associated with the QueryDescriptor. |
abstract AttributeCriterion |
getCurrentCriterion() Gets the Criterion to use as the default or the current criterion. |
abstract java.lang.String |
getName() Returns the name of the QueryDescriptor. |
abstract java.util.Map<java.lang.String,java.lang.Object> |
getUIHints() Return a Map of UI hints to values, for this QueryDescriptor. |
abstract void |
removeCriterion(Criterion object) Removes a criterion/item from the QueryDescriptor. |
abstract void |
setCurrentCriterion(AttributeCriterion attrCriterion) Sets the AttributeCriterion object as the current one. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String UIHINT_AUTO_EXECUTE
public static final java.lang.String UIHINT_DEFAULT
public static final java.lang.String UIHINT_IMMUTABLE
public static final java.lang.String UIHINT_MODE
public static final java.lang.String UIHINT_NAME
public static final java.lang.String UIHINT_RESULTS_COMPONENT_ID
public static final java.lang.String UIHINT_SAVE_RESULTS_LAYOUT
public static final java.lang.String UIHINT_SHOW_IN_LIST
Constructor Detail |
---|
public QueryDescriptor()
Method Detail |
---|
public abstract void addCriterion(java.lang.String name)
This method is invoked during the 'Invoke Application' phase. Subclasses can create a new Criterion based on the AttributeDescriptor (retrieved using the name). The query component registers an internal ActionListener to invoke this method when the user chooses to add an attribute (AttributeDescriptor) as a search field (AttributeCriterion).
name
- of the attribute that is to be added as a Criterion to the search criteriaAttributeCriterion
, AttributeDescriptor
public abstract void changeMode(QueryDescriptor.QueryMode mode)
mode
- the new value for QueryMode.public abstract ConjunctionCriterion getConjunctionCriterion()
ConjunctionCriterion
public abstract java.lang.String getName()
public abstract java.util.Map<java.lang.String,java.lang.Object> getUIHints()
public abstract void removeCriterion(Criterion object)
This method is invoked during the 'Invoke Application' phase. The query component registers an internal ActionListener to invoke this method when the user chooses to delete a search field.
object
- the criterion instance that is to be removed. Typically an AttributeCriterion.AttributeCriterion
public abstract AttributeCriterion getCurrentCriterion()
ConjunctionCriterion.getCriterionList()
public abstract void setCurrentCriterion(AttributeCriterion attrCriterion)
attrCriterion
- an AttributeCriterion instance to use as the current one. A null value throws an IllegalArgumentException
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.0.0) E17488-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |