@ExperimentalSpi
public interface ContentNameSearchSectionSpec
ContentNameSearchSection
is populated. It can be used by a plugin to extend the
content name search functionality for CustomContentEntityObject
in a
much more efficient way comparing to ContentNameSearchSectionsProvider
.Modifier and Type | Method and Description |
---|---|
Category |
getCategory()
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 of
SearchResult . |
default int |
getLimit()
Limit the number of returned entities.
|
SearchFilter |
getSearchFilter()
Search index filter that accepts only desire content entities.
|
Function<SearchResult,ContentNameMatch> |
getSearchResultTransformer()
Returns a function that transforms a
SearchResult into ContentNameMatch . |
default int |
getWeight()
Relative order of the contents section with respect to other sections.
|
default boolean |
isDefault()
Returns
true of the section is added into the system by default. |
Category getCategory()
default boolean isDefault()
true
of the section is added into the system by default.SearchFilter getSearchFilter()
default int getWeight()
default int getLimit()
Function<List<Map<String,String>>,List<SearchResult>> getFieldValuesTransformer()
SearchResult
. Using list as
input and output arguments allows an implementation to perform an additional filter that can't be done on the
search index.Function<SearchResult,ContentNameMatch> getSearchResultTransformer()
SearchResult
into ContentNameMatch
.Copyright © 2003–2021 Atlassian. All rights reserved.