Interface Search
-
- All Superinterfaces:
Component
,ComponentExporter
public interface Search extends Component
Defines theSearch
Sling Model used for the/apps/core/wcm/components/search
component.- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PN_RESULTS_SIZE
Name of the configuration policy property that defines the maximal number of results fetched by a search request.static java.lang.String
PN_SEARCH_ROOT
Name of the resource / configuration policy property that defines the site's search root from which to search.static java.lang.String
PN_SEARCH_TERM_MINIMUM_LENGTH
Name of the configuration policy property that defines the minimum length of the search term to start the search.
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default @NotNull java.lang.String
getExportedType()
Returns the type of the resource for which the export is performed.default @NotNull java.lang.String
getRelativePath()
Relative path of the search component in the current page.default int
getResultsSize()
The maximal number of results fetched by a search request.default int
getSearchTermMinimumLength()
The minimum length of the search term to start the search.
-
-
-
Field Detail
-
PN_SEARCH_ROOT
static final java.lang.String PN_SEARCH_ROOT
Name of the resource / configuration policy property that defines the site's search root from which to search. The property should provide a String value.- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
- See Also:
- Constant Field Values
-
PN_SEARCH_TERM_MINIMUM_LENGTH
static final java.lang.String PN_SEARCH_TERM_MINIMUM_LENGTH
Name of the configuration policy property that defines the minimum length of the search term to start the search.- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
- See Also:
- Constant Field Values
-
PN_RESULTS_SIZE
static final java.lang.String PN_RESULTS_SIZE
Name of the configuration policy property that defines the maximal number of results fetched by a search request.- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
getResultsSize
default int getResultsSize()
The maximal number of results fetched by a search request.- Returns:
- number of results
- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
-
getSearchTermMinimumLength
default int getSearchTermMinimumLength()
The minimum length of the search term to start the search.- Returns:
- minimum length of the search term
- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
-
getRelativePath
@NotNull default @NotNull java.lang.String getRelativePath()
Relative path of the search component in the current page.- Returns:
- the relative path of search inside the current page
- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
-
getExportedType
@NotNull default @NotNull java.lang.String getExportedType()
Description copied from interface:ComponentExporter
Returns the type of the resource for which the export is performed.
NOTE: methods whose JSON serialization would lead to the same JSON property name (":type") will not be serialized.
- Specified by:
getExportedType
in interfaceComponent
- Specified by:
getExportedType
in interfaceComponentExporter
- Returns:
- the type of the component
- Since:
- com.adobe.cq.wcm.core.components.models 12.2.0
- See Also:
ComponentExporter.getExportedType()
-
-