Class Name |
|
|---|---|
Component |
|
This servlet bean takes as input a String representing a facet trail, plus additional input parameters specifying modifications to the facet trail. It outputs the modified facet trail as a FacetTrail object, which can then be rendered on the page or used to construct a subsequent search request.
The input parameters can be set explicitly or they can be set by the page’s URL query parameters. For example, when a customer clicks a link for a selection value, the query parameter corresponding to the servlet bean’s addFacet parameter can be set to this selection value. When the new page is displayed, the chosen value will appear at the end of the facet trail. Similarly, another link could be used to remove a selection value or range from the facet trail.
Properties
The following table describes the properties of the CommerceFacetTrailDroplet component and their default settings. Note that each property whose name ends with “ParameterName” specifies the name of the query parameter that supplies the value to use for the corresponding input parameter if the input parameter is not supplied.
Property | Description |
|---|---|
| Specifies the component used to retrieve items from the refinement repository. Default: |
| The character used as a separator between the facets and the faceting property values in the facet trail. Default: the colon character ( |
| A String appended to a selection range in the facet trail if the range is the last one for a particular facet. Default: LAST |
| Separator placed between a selection range and the |
| The name of the property of the category repository item that contains a reference to the refinement configuration for the category. Default: |
| The name of the query parameter that specifies the value to use for the |
| The name of the query parameter that specifies the value to use for the |
| The name of the query parameter that specifies the value to use for the |
| The name of the query parameter that specifies the value to use for the |
| The name of the query parameter that specifies the value to use for the |
Input Parameters
trail
String that represents the current facet trail. This parameter’s value is typically specified through a query parameter in the URL for the page. The name of the query parameter that sets the value of this input parameter is configured through the trailParameterName property.
refineConfig
The refineConfig repository item to use for querying Oracle ATG Web Commerce Search. If this value is not specified, the refinement configuration will be chosen automatically.
addFacet
String that represents an entry (consisting of a facet and an associated selection value or range) to add to the facet trail. This parameter’s value is typically specified through a query parameter in the URL for the page. The name of the query parameter that sets the value of this input parameter is configured through the addFacetParameterName property.
removeFacet
String that represents an entry to remove from the trail. This parameter’s value is typically specified through a query parameter in the URL for the page. The name of the query parameter that sets the value of this input parameter is configured through the removeFacetParameterName property.
removeAllFacets
If this parameter is set to true, the facet trail is cleared. This parameter’s value is typically specified through a query parameter in the URL for the page. The name of the query parameter that sets the value of this input parameter is configured through the removeAllFacetsParameterName property.
removeFacetType
The item ID of a refinement element repository item (i.e., a facet); specifies that all facet values or ranges for this facet should be removed from the facet trail. This parameter’s value is typically specified through a query parameter in the URL for the page. The name of the query parameter that sets the value of this input parameter is configured through the removeFacetTypeParameterName property.
Output Parameters
facetTrail
The FacetTrail object generated from the input or query parameters.
errorMessage
The message generated if an error occurs when creating the FacetTrail object.
Open Parameters
output
This open parameter is rendered if no errors occur when creating the FacetTrail object.
error
This open parameter is rendered if any errors occur when creating the FacetTrail object.
Examples
For examples of using the CommerceFacetTrailDroplet, see the Faceted Search chapter.
