Interface ContentNameSearchSectionSpec
-
@ExperimentalSpi public interface ContentNameSearchSectionSpecSpecifies how aContentNameSearchSectionis populated. It can be used by a plugin to extend the content name search functionality forCustomContentEntityObjectin a much more efficient way comparing toContentNameSearchSectionsProvider.- Since:
- 6.7
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CategorygetCategory()Content category usually one per content type.Set<String>getFields()Requested fields from the search index.Function<List<Map<String,String>>,List<SearchResult>>getFieldValuesTransformer()Returns a function that transforms a list of field value map into the one ofSearchResult.SearchQuerygetFilter()default intgetLimit()Limit the number of returned entities.Function<SearchResult,ContentNameMatch>getSearchResultTransformer()Returns a function that transforms aSearchResultintoContentNameMatch.default intgetWeight()Relative order of the contents section with respect to other sections.default booleanisDefault()Returnstrueof the section is added into the system by default.
-
-
-
Method Detail
-
getCategory
Category getCategory()
Content category usually one per content type.
-
isDefault
default boolean isDefault()
Returnstrueof the section is added into the system by default.
-
getFilter
SearchQuery getFilter()
- Since:
- 7.20 Search query filter that accepts only desired content entities.
-
getWeight
default int getWeight()
Relative order of the contents section with respect to other sections.
-
getLimit
default int getLimit()
Limit the number of returned entities.
-
getFieldValuesTransformer
Function<List<Map<String,String>>,List<SearchResult>> getFieldValuesTransformer()
Returns a function that transforms a list of field value map into the one ofSearchResult. Using list as input and output arguments allows an implementation to perform an additional filter that can't be done on the search index.
-
getSearchResultTransformer
Function<SearchResult,ContentNameMatch> getSearchResultTransformer()
Returns a function that transforms aSearchResultintoContentNameMatch.
-
-