This class provides an interface to refinement options for the content asset search. In a typical usage, the client application UI displays the search refinements along with the search results and allows customers to “refine” the results (i.e. limit the results that are shown) by specifying additional criteria, or “relax” (i.e. broaden) the results after previously refining. The two types of content search refinements are:
Rendering a content search refinement UI typically begins with iterating the refinement definitions for the search result. Call SearchRefinements.getRefinementDefinitions() or SearchRefinements.getAllRefinementDefinitions() to retrieve the appropriate collection of refinement definitions. For each definition, display the available refinement values by calling getAllRefinementValues(ContentSearchRefinementDefinition). Depending on the type of the refinement definition, the application must use slightly different logic to display the refinement widgets. For all 2 types, methods in ContentSearchModel are used to generate URLs to render hyperlinks in the UI. When clicked, these links trigger a call to the Search pipelet which in turn applies the appropriate filters to the native search result.
| Property | Description |
|---|---|
folderRefinementDefinition: ContentSearchRefinementDefinition (read-only) | Returns the appropriate folder refinement definition based on the search result. |
matchingFolders: Collection (read-only) | Returns a collection of matching folders. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getAllRefinementValues(ContentSearchRefinementDefinition) | Returns a sorted collection of refinement values for the given refinement definition. |
| getFolderHits(Folder) | Returns the number of search hits for the passed folder object. |
| getFolderRefinementDefinition() | Returns the appropriate folder refinement definition based on the search result. |
| getMatchingFolders() | Returns a collection of matching folders. |
| getNextLevelFolderRefinementValues(Folder) | Returns folder refinement values based on the current search result filtered such that only folder refinements representing children of the given folder are present. |
| getRefinementValue(ContentSearchRefinementDefinition, String) | Returns the refinement value (incl. |
| getRefinementValue(String, String) | Returns the refinement value (incl. |
| getRefinementValues(ContentSearchRefinementDefinition) | Returns a collection of refinement values for the given refinement definition. |
getAllRefinementDefinitions, getAllRefinementValues, getAllRefinementValues, getRefinementDefinitions, getRefinementValues
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
(read-only)Returns the appropriate folder refinement definition based on the search result. The folder refinement definition returned will be the first that can be found traversing the folder tree upward starting at the deepest common folder of the search result.
(read-only)Returns a collection of matching folders.
Returns a sorted collection of refinement values for the given refinement definition. The returned collection includes all refinement values for which the hit count is greater than 0 within the search result when the passed refinement definitions is excluded from filtering the search hits but all other refinement filters are still applied. This is useful for rendering broadening options for the refinement definitions that the search is already refined by. It is important to note that this method does NOT return refinement values independent of the search result.
Parameters:
Returns:
Returns the number of search hits for the passed folder object.
Parameters:
Returns:
Returns the appropriate folder refinement definition based on the search result. The folder refinement definition returned will be the first that can be found traversing the folder tree upward starting at the deepest common folder of the search result.
Returns:
null if none can
be found.Returns a collection of matching folders.
Returns:
Returns folder refinement values based on the current search result filtered such that only folder refinements representing children of the given folder are present. If no folder is given, the method uses the library's root folder. The refinement value content counts represent all hits contained in the library tree starting at the corresponding child folder.
Parameters:
Returns:
Returns the refinement value (incl. content hit count) for the given refinement definition and the given (selected) value.
Parameters:
Returns:
Returns the refinement value (incl. content hit count) for the given attribute refinement and the given (selected) value.
Parameters:
Returns:
Returns a collection of refinement values for the given refinement definition. The returned refinement values only include those that are part of the actual search result (i.e. hit count will always be > 0).
Parameters:
Returns:
j