Package org.ametys.cms.search

Interface SearchField

All Known Implementing Classes:
AbstractModelItemSearchField, AbstractNoJoinSystemSearchField, BooleanSearchField, CollectionSearchField, CommentsSearchField, ContentIdSearchField, ContentPrivacySearchField, ContentSearchField, ContentTypeSearchField, ContributorSearchField, CreationDateSearchField, CreatorSearchField, DateSearchField, DoubleSearchField, DublinCoreSearchField, FirstValidationSearchField, FirstValidatorSearchField, HasLiveVersionSearchField, JoinedSystemSearchField, LanguageSearchField, LastMajorValidationSearchField, LastMajorValidatorSearchField, LastModifiedSearchField, LastValidationSearchField, LastValidatorSearchField, LongSearchField, MixinTypeSearchField, MultilingualStringSearchField, OrphanSearchField, PageIdsSearchField, PagesSearchField, ParentContentSearchField, SharedSeachField, SiteSearchField, SiteTypeSearchField, StringSearchField, TagSearchField, WorkflowNameSearchField, WorkflowStepSearchField
public interface SearchField
Represents a search field.

  • Method Details

    • 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.