[ADF-4152] Restructured Content Services docs (#4429)

* [ADF-4152] Moved content services docs to subfolders * [ADF-4152] Manual URL fixes for cont services docs * [ADF-4152] Moved content services docs to subfolders * [ADF-4152] Manual URL fixes for cont services docs * [ADF-4152] Updated doc index pages for content services
2025-07-24 17:32:15 +00:00 · 2019-03-13 18:44:37 +00:00
parent bc5208b767
commit dfea5c2f04
72 changed files with 958 additions and 1055 deletions
--- a/docs/content-services/services/search-query-builder.service.md
+++ b/docs/content-services/services/search-query-builder.service.md
@@ -0,0 +1,104 @@
+---
+Title: Search Query Builder service 
+Added: v2.3.0
+Status: Active
+Last reviewed: 2018-06-12
+---
+
+# [Search Query Builder service](../../../lib/content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts")
+
+Stores information from all the custom search and faceted search widgets, compiles and runs the final search query.
+
+## Class members
+
+### Methods
+
+-   **addFilterQuery**(query: `string`)<br/>
+    Adds a filter query to the current query.
+    -   _query:_ `string`  - Query string to add
+-   **addUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts))<br/>
+    Adds a facet bucket to a field.
+    -   _field:_ [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts)  - The target field
+    -   _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts)  - Bucket to add
+-   **buildQuery**(): `QueryBody`<br/>
+    Builds the current query.
+    -   **Returns** `QueryBody` - The finished query
+-   **execute**()<br/>
+    Builds and executes the current query.
+-   **getFacetField**(label: `string`): [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts)<br/>
+    Gets a facet field by label.
+    -   _label:_ `string`  - Label of the facet field
+    -   **Returns** [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts) - Facet field data
+-   **getFacetQuery**(label: `string`): [`FacetQuery`](../../../lib/content-services/search/facet-query.interface.ts)<br/>
+    Gets a facet query by label.
+    -   _label:_ `string`  - Label of the query
+    -   **Returns** [`FacetQuery`](../../../lib/content-services/search/facet-query.interface.ts) - Facet query data
+-   **getPrimarySorting**(): [`SearchSortingDefinition`](../../../lib/content-services/search/search-sorting-definition.interface.ts)<br/>
+    Gets the primary sorting definition.
+    -   **Returns** [`SearchSortingDefinition`](../../../lib/content-services/search/search-sorting-definition.interface.ts) - The primary sorting definition
+-   **getQueryGroup**(query: `any`): `any`<br/>
+    Gets the query group.
+    -   _query:_ `any`  - Target query
+    -   **Returns** `any` - Query group
+-   **getSortingOptions**(): [`SearchSortingDefinition`](../../../lib/content-services/search/search-sorting-definition.interface.ts)`[]`<br/>
+    Gets all pre-configured sorting options that users can choose from.
+    -   **Returns** [`SearchSortingDefinition`](../../../lib/content-services/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options
+-   **getSupportedLabel**(configLabel: `string`): `string`<br/>
+
+    -   _configLabel:_ `string`  - 
+    -   **Returns** `string` - 
+
+-   **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts)`[]`<br/>
+    Gets the buckets currently added to a field
+    -   _field:_ `string`  - The target fields
+    -   **Returns** [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts)`[]` - Bucket array
+-   **removeFilterQuery**(query: `string`)<br/>
+    Removes an existing filter query.
+    -   _query:_ `string`  - The query to remove
+-   **removeUserFacetBucket**(field: [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts))<br/>
+    Removes an existing bucket from a field.
+    -   _field:_ [`FacetField`](../../../lib/content-services/search/facet-field.interface.ts)  - The target field
+    -   _bucket:_ [`FacetFieldBucket`](../../../lib/content-services/search/facet-field-bucket.interface.ts)  - Bucket to remove
+-   **resetToDefaults**()<br/>
+    Resets the query to the defaults specified in the app config.
+-   **update**()<br/>
+    Builds the current query and triggers the `updated` event.
+
+## Details
+
+See the [Search filter component](../components/search-filter.component.md) page for full details about the format of queries,
+facet fields, and sorting options.
+
+The Query Builder is UI agnostic and does not rely on Angular components.
+You can reuse it with multiple component implementations.
+
+You can use custom widgets to populate and edit the following parts of the resulting query:
+
+-   categories
+-   query fragments that form a query expression
+-   include fields
+-   scope settings
+-   filter queries
+-   facet fields
+-   range queries
+
+```ts
+constructor(queryBuilder: SearchQueryBuilderService) {
+
+    queryBuilder.updated.subscribe(query => {
+        this.queryBuilder.execute();
+    });
+
+    queryBuilder.executed.subscribe(data => {
+        this.onDataLoaded(data);
+    });
+
+}
+```
+
+> **Note:** Since ADF 3.0.0, the query contains the `"facetFormat": "V2"` parameter so that all the responses have the same structure even if coming from search queries containing facetFields, facetQueries, grouped facetQueries or facetIntervals.
+
+## See also
+
+-   [Search filter component](../components/search-filter.component.md)
+-   [Search Widget interface](../interfaces/search-widget.interface.md)