<af:query>

af:query query query

UIComponent class: oracle.adf.view.rich.component.rich.RichQuery
Component type: oracle.adf.RichQuery

Naming container: Yes. When referring to children of this component ("partialTriggers", findComponent(), etc.), you must prefix the child's ID with this component's ID and a colon (':')

The query component provides the user the ability to perform a query based on a saved search or personalize saved searches. The component displays a search panel with various elements, each of which help the user to accomplish various tasks.

To properly render the query panel when content width is more than view area, it should be wrapped in a af:panelGroupLayout with layout="horizontal". For ex:

 <af:panelGroupLayout layout="horizontal" inlineStyle="width:100%" >
    <af:query id="queryId" rows="3" headerText="Search" disclosed="true"
              model="#{demoQuery.queryModel}" queryListener="#{demoQuery.processQuery}"/>
 </af:panelGroupLayout>
          

Elements rendered by the query component

• Search Panel: the panel that encloses all elements rendered by the query component
• Search Header: Spans the entire width of the search panel and used to display a disclosure icon, the label, search mode (toggle button) and saved search (choice list of saved searches). The help (deprecated), info and toolbar facets' content is also displayed in the header.
• Match Type: A radio button group that appears below the search header, it defines whether the search criteria should be treated as an AND search or an OR search. For details on the conjunction operators refer to the QueryDescriptor and ConjunctionCriterion classes.
• Criteria region: A form layout that appears below the Match type, it contains search fields that define the search parameters. For details on search fields refer to the QueryDescriptor model.
• Criterion: A criterion represents a single search field, that comprises of an operator and one or more value fields. For value fields that render LOV components, the autoComplete feature is not enabled unless either of the methods, AttributeCriterion.hasDependentCriterion() or ListOfValuesModel.isAutoCompleteEnabled() return true. This is done to allow the end-user to enter partial values with wild-cards and tab around the search panel without causing the LOV dialog to be launched (everytime they tab-out of the LOV value field).
• Action buttons: The search panel has four action buttons: Search, Reset, Save, and Add Fields. The action buttons appear below the criteria region. They are end-aligned within the search header.
• NOTE: The Add Fields feature is only available in the Advanced mode.

Tasks performed using a query component

The following actions are performed on the currently selected saved search.

• Perform Search: Executes a query based on the search criteria (values entered for the search fields). Exposed as the Search button
• Add Criterion: Adds the selected attribute (represented by an AttributeDescriptor) as a criterion to the current saved search in the search panel (represented by a QueryDescriptor object). The query component by default registers an internal ActionListener for the associated ActionEvent and invokes the addCriterion method in the QueryDescriptor.
• Remove Criterion: Removes the search field (aka AttributeCriterion). The user can click the remove butcon that appears next to certain search fields. The query component by default registers an internal ActionListener for the ActionEvent that is fired as part of the delete and invokes the deleteCriterion method in the QueryDescriptor.
• Toggle Mode: Toggles the mode of the search panel between Basic and Advanced
• Change Conjunction: Changes the conjunction operator to be used when executing a query.

The following actions are performed on saved searches:

• Create: Create a new saved search based on the current search criteria used on the search panel. Exposed as the Save.. button on the Search panel.
• Reset: Resets the saved search to its default state. Exposed as the Reset button.
• Select: Saved searches (displayed in a choice list on the search panel header) can be changed. This allows the user to update the criteria to match that of the selected saved search. The action may also execute the search depending on how the saved search is configured.
• Personalize a saved search: The "Personalize..." option is displayed in the Saved Search choice list. Selecting this option opens the "Personalize Saved Searches" dialog, which allows user to personalize the saved search in the following ways.
  • Update a Saved Search: Change the name and UIHints for the selected saved search. Users are prevented from updating a saved search that is marked as immutable. The Apply and Ok buttons can be used to commit the changes.
  • Delete a Saved Search: delete the selected saved search (by using the Delete button). Users are prevented from changing a system saved search.
  • Duplicate a Saved Search: Clone the selected saved search (by using the Duplicate button).

Events

QueryOperationEvent is fired for operations performed on saved searches. The operations include changeMode, create, duplicate, delete, reset, select and update. The specific operation that triggers this event is stored as part of the QueryOperationEvent object. The query component by default registers an internal QueryOperationListener and invokes specific methods on the QueryModel. Please refer to the QueryModel for more details.

QueryEvent is fired in response to the user action to perform a query. For e.g., when the user hits the Search button or if the currently selected saved search is configured to "Run Automatically" when selected in the Saved Search choice list.

Geometry Management

• This component will be stretched if:
  • type="default" and its parent layout component is stretching the query (e.g. panelDashboard)
  • type="stretch"
• This component will not be stretched if:
  • type="default" and its parent layout component is not stretching the query (e.g. panelGroupLayout)
  • type="flow"
• The query component will only stretch its children if it is being stretched by its parent (or if type="stretch").

Screen Shot(s)

A query component.

Events

Supported Facets

Attributes