dw.content
Class ContentSearchRefinements
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:
- Refine By Folder: Limit the content assets to those assigned to specific child/ancestor folder of the search folder.
- Refine By Attribute: Limit the content assets to those with specific values for a given attribute. Values may be grouped into "buckets" so that a given set of values are represented as a single refinement option.
Properties
folderRefinementDefinition
:
ContentSearchRefinementDefinition
(Read Only)
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.
matchingFolders
:
Collection
(Read Only)
A collection of matching folders.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getAllRefinementValues(definition
:
ContentSearchRefinementDefinition)
:
Collection
Returns a sorted collection of refinement values for the given refinement definition.
getFolderHits(folder
:
Folder)
:
Number
Returns the number of search hits for the passed folder object.
getFolderRefinementDefinition()
:
ContentSearchRefinementDefinition
Returns the appropriate folder refinement definition based on the search result.
getMatchingFolders()
:
Collection
Returns a collection of matching folders.
getNextLevelFolderRefinementValues(folder
:
Folder)
:
Collection
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(definition
:
ContentSearchRefinementDefinition, value
:
String)
:
ContentSearchRefinementValue
Returns the refinement value (incl.
getRefinementValue(name
:
String, value
:
String)
:
ContentSearchRefinementValue
Returns the refinement value (incl.
getRefinementValues(definition
:
ContentSearchRefinementDefinition)
:
Collection
Returns a collection of refinement values for the given refinement definition.
Methods inherited from class
SearchRefinements
Salesforce Commerce Cloud Courses
Salesforce B2C Commerce Developer - Certification Tests
Why risk failing the SFCC exam? Get 180 real questions, killer content, and everything you need to crush the Salesforce B2C Commerce Developer certification.
Becoming a Salesforce B2C Commerce Developer is your ticket to higher salaries, better job opportunities, and the credibility to stand out from the competition. But let's be honestβpassing the certification exam isn't easy. That's where we come in.
Becoming a Salesforce B2C Commerce Developer is your ticket to higher salaries, better job opportunities, and the credibility to stand out from the competition. But let's be honestβpassing the certification exam isn't easy. That's where we come in.
Salesforce Javascript Developer I - Certification Tests
Not just another prep courseβthis is your shortcut to passing. Master JavaScript for Salesforce and go from 'hoping to pass' to knowing you will. Ready to start?
This isn't just another prep courseβit's your shortcut to mastering the skills and confidence you need to pass. With multiple practice tests covering every section and a final exam simulation designed to mirror the real thing, you'll feel like you've already aced it before test day.
This isn't just another prep courseβit's your shortcut to mastering the skills and confidence you need to pass. With multiple practice tests covering every section and a final exam simulation designed to mirror the real thing, you'll feel like you've already aced it before test day.
Salesforce B2C Commerce Architect - Certification Tests
Think the Developer exam was hard? Welcome to the next level.
The Salesforce B2C Commerce Architect certification is a whole different gameβcomplex solutions, elevated difficulty, and skills that set you apart in the eCommerce industry. That's why we're including 11 downloadable PDF guides, packed with best practices and strategies to help you prepare for the exam and build confidence in every topic.
The Salesforce B2C Commerce Architect certification is a whole different gameβcomplex solutions, elevated difficulty, and skills that set you apart in the eCommerce industry. That's why we're including 11 downloadable PDF guides, packed with best practices and strategies to help you prepare for the exam and build confidence in every topic.
Methods inherited from class
Object
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
Method Detail
getAllRefinementValues
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:
definition
-
The refinement definition to return refinement values for.
Returns:
The collection of ContentSearchRefinementValue instances sorted according to the settings of the definition.
getFolderHits
Returns the number of search hits for the passed folder object.
Parameters:
folder
-
Folder object.
Returns:
Number of search hits.
getFolderRefinementDefinition
getFolderRefinementDefinition()
:
ContentSearchRefinementDefinition
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:
The folder refinement definition or
null
if none can be found.
getMatchingFolders
getMatchingFolders()
:
Collection
Returns a collection of matching folders.
Returns:
Collection of matching folders.
getNextLevelFolderRefinementValues
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:
folder
-
The folder to return child folder refinement values for.
Returns:
The refinement values for all child folders of the given folder.
getRefinementValue
getRefinementValue(definition
:
ContentSearchRefinementDefinition, value
:
String)
:
ContentSearchRefinementValue
Returns the refinement value (incl. content hit count) for the given
refinement definition and the given (selected) value.
Parameters:
definition
-
The definition to return the refinement for.
value
-
The value to return the refinement value for.
Returns:
The refinement value.
getRefinementValue
Returns the refinement value (incl. content hit count) for the given
attribute refinement and the given (selected) value.
Parameters:
name
-
The name of the refinement attribute.
value
-
The value to return the refinement value for.
Returns:
The refinement value.
getRefinementValues
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:
definition
-
The refinement definition to return refinement values for.
Returns:
The collection of refinement values sorted according to the settings of the definition.