4.12.21 p:performFacetedQuery

Returns the result of executing a query.

4.12.21.1 Request

Syntax:

  <p:performFacetedQuery>
    <p:options>
      <p:additionalSelects>
        <p:expression>name</p:expression>
        <p:expression>summary</p:expression>
      </p:additionalSelects>
      <p:defaultConditions>documentType='SimpleDocument'</p:defaultConditions>
      <p:defaultSortOrder>name asc</p:defaultSortOrder>
      <p:queryOptions>
        <p:queryOption name="include_retired" value="true"/>
      </p:queryOptions>
    </p:options>
    <p:facets>
      <p:facet expression="variantLastModifierLogin" maxValues="10" sortOnValue="true" sortAscending="false" type="default">
        <p:properties>
          <p:property name="" value=""/>
        </p:properties>
      <p:facet>
    </p:facets>
  </p:performFacetedQuery>

This syntax is similar to the one for the faceted browser definition.

4.12.21.1.1 Options

All options are, as the name says, optional. The options element is not optional.

• p:defaultConditions expects a clause that would go in the where part of a Daisy query. If this element is missing then it will default to 'true'.
  If there is a context document available (i.e. if this p:performFacetedQuery is used inside a p:document) then the ContextDoc function can be used in the query.
• p:defaultSortOrder specifies the order in which the search results should be sorted.
• p:queryOptions is an element that sets query options like 'search_last_version'.
• p:additionalSelects allows specifications of identifiers other than those of the facets.

4.12.21.1.2 Facets

Each facet element defines a facet.
Attributes :

• expression is the only required part of a facet definition. It expects a query expression to build the facet with.
• maxValues sets the maximum amount of facet values to be returned. This attribute is optional and defaults to unlimited (-1).
• sortOnValue sets whether facets should be sorted according to their value(true) or count(false). This is optional and defaults to true.
• sortAscending sets whether facets should be sorted ascending(true) or decending(false). Defaults to true.
• type sets the facet type. These are the same types as the facet browser. Defaults to 'default'.

4.12.21.2 Response

The result of a query is a d:facetedQueryResult element.