SearchField (Ametys 4.3.x - API)

All Known Implementing Classes:

AbstractMetadataSearchField, AbstractNoJoinSystemSearchField, BooleanSearchField, CollectionSearchField, CommentsSearchField, CommonPseudoContentTypeFacetDefinition.PseudoContentTypeSearchField, ContentFacetDefinition.ProxySearchField, ContentPrivacySearchField, ContentSearchField, ContentTypeSearchField, ContributorSearchField, CreationDateSearchField, CreatorSearchField, DateSearchField, DoubleSearchField, DublinCoreSearchField, FirstValidationSearchField, JoinedSystemSearchField, LanguageSearchField, LastMajorValidationSearchField, LastModifiedSearchField, LastValidationSearchField, LongSearchField, MixinTypeSearchField, MultilingualStringSearchField, OrphanSearchField, PageContentFacetDefinition.PageContentSearchField, PageIdsSearchField, PagesSearchField, ParentContentSearchField, SearchGenerator.ContentTypeSearchField, SharedSeachField, SiteSearchField, SiteTypeSearchField, StringSearchField, TagSearchField, WorkflowStepSearchField
```
public interface SearchField
```
Represents a search field.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`String`	`getFacetField()`	Get the facet field corresponding to this field.
`default String`	`getFacetFunction()`	Get the facet function corresponding to this field.
`List<String>`	`getJoinedPaths()`	Gets the joined paths
`String`	`getName()`	Get the search field name.
`String`	`getSortField()`	Get the sort field corresponding to this field.
`boolean`	`isJoined()`	Indicates if the search field is joined

- Method Detail
  - getName
```
String getName()
```
    Get the search field name.
    
    Returns:
    
    The search field name.
  - getSortField
```
String getSortField()
```
    Get the sort field corresponding to this field.
    
    Returns:
    
    The sort field.
  - getFacetField
```
String getFacetField()
```
    Get the facet field corresponding to this field.
    
    Returns:
    
    The facet field.
  - isJoined
```
boolean isJoined()
```
    Indicates if the search field is joined
    
    Returns:
    
    true if the search field is joined
  - getJoinedPaths
```
List<String> getJoinedPaths()
```
    Gets the joined paths
    
    Returns:
    
    the joined paths
  - getFacetFunction
```
default String getFacetFunction()
```
    Get the facet function corresponding to this field.
    
    Returns:
    
    The facet function.