Package org.ametys.cms.search.model

Interface SearchModel

All Known Subinterfaces:
SearchUIModel
All Known Implementing Classes:
AbstractSearchUIModel, CriteriaSearchModelWrapper, DefaultSearchModel, DefaultSearchUIModel, DynamicWrappedSearchUIModel, ReferenceTableSearchUIModel, ReferencingContentsWithSameValuesSearchUIModel, SearchModelWrapper, StaticSearchUIModel
public interface SearchModel
This interface represents a search model.

  • Method Details

    • getContentTypes

      Set<String> getContentTypes(Map<String,Object> contextualParameters)
      Get the list of content types.
      Parameters:
      contextualParameters - the contextual parameters.
      Returns:
      The list of content types.

    • getExcludedContentTypes

      Set<String> getExcludedContentTypes(Map<String,Object> contextualParameters)
      Get the list of excluded content types.
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      The list of excluded content types.

    • getCriteria

      Map<String,? extends SearchCriterion> getCriteria(Map<String,Object> contextualParameters)
      Get the list of search criteria in simple mode
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      the list of search criteria in simple mode

    • getCriterion

      default SearchCriterion getCriterion(String id, Map<String,Object> contextualParameters)
      Get a simple search criterion by its id
      Parameters:
      id - The search criterion id
      contextualParameters - the contextual parameters
      Returns:
      the criterion or null if not found

    • getFacetedCriteria

      Map<String,? extends SearchCriterion> getFacetedCriteria(Map<String,Object> contextualParameters)
      Get the list of faceted search criteria.
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      the list of faceted search criteria.

    • getFacetedCriterion

      default SearchCriterion getFacetedCriterion(String id, Map<String,Object> contextualParameters)
      Get a faceted search criterion by its id.
      Parameters:
      id - The faceted search criterion id.
      contextualParameters - the contextual parameters
      Returns:
      the faceted criterion or null if not found

    • getResultItems

      ViewItemContainer getResultItems(Map<String,Object> contextualParameters)
      Retrieves the search result items
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      the search result items

    • getResultItem

      default ModelViewItem getResultItem(String itemPath, Map<String,Object> contextualParameters)
      Retrieves the search result item with the given path
      Parameters:
      itemPath - the path of the result item to retrieve
      contextualParameters - the contextual parameters
      Returns:
      the search result item with

    • getWorkspace

      String getWorkspace(Map<String,Object> contextualParameters)
      Get the specific workspace to use.
      Parameters:
      contextualParameters - the contextual parameters.
      Returns:
      the workspace to use when searching, or null to use the default workspace.