Package org.ametys.cms.search.ui.model

Interface SearchUIModel

All Superinterfaces:
Labelable, Model, ModelItemAccessor, ModelItemContainer, SearchModel
All Known Implementing Classes:
DefaultSearchUIModel, ReferenceTableSearchUIModel, ReferencingContentsWithSameValuesSearchUIModel, SearchModelWrapper, SkillSearchUIModel, StaticSearchUIModel
public interface SearchUIModel extends SearchModel, Labelable
Search tool model.

  • Field Details

  • Method Details

    • addCriterion

      default void addCriterion(SearchModelCriterionDefinition criterion, Map<String,Object> contextualParameters)
      Description copied from interface: SearchModel
      Add the given criterion to the simple criteria
      Specified by:
      addCriterion in interface SearchModel
      Parameters:
      criterion - the criterion to add
      contextualParameters - the contextual parameters

    • addCriterion

      default void addCriterion(ViewItem criterion, Map<String,Object> contextualParameters)
      Add the given criterion to the simple criteria
      Parameters:
      criterion - the criterion to add
      contextualParameters - the contextual parameters

    • addFacetedCriterion

      default void addFacetedCriterion(SearchModelCriterionDefinition criterion, Map<String,Object> contextualParameters)
      Description copied from interface: SearchModel
      Add the given criterion to the faceted criteria
      Specified by:
      addFacetedCriterion in interface SearchModel
      Parameters:
      criterion - the criterion to add
      contextualParameters - the contextual parameters

    • addFacetedCriterion

      default void addFacetedCriterion(SearchModelCriterionViewItem criterion, Map<String,Object> contextualParameters)
      Add the given criterion to the faceted criteria
      Parameters:
      criterion - the criterion to add
      contextualParameters - the contextual parameters

    • getAdvancedCriteria

      ViewItemContainer getAdvancedCriteria(Map<String,Object> contextualParameters)
      Retrieves the criteria in advanced mode
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      the criteria in advanced mode

    • getAdvancedCriterion

      default ModelViewItem getAdvancedCriterion(String name, Map<String,Object> contextualParameters)
      Retrieves the advanced criterion with the given name
      Parameters:
      name - The name of the faceted criterion to retrieve
      contextualParameters - the contextual parameters
      Returns:
      the advanced criterion or null if not found

    • addAdvancedCriterion

      default void addAdvancedCriterion(SearchModelCriterionDefinition criterion, Map<String,Object> contextualParameters)
      Add the given criterion to the advanced criteria
      Parameters:
      criterion - the criterion to add
      contextualParameters - the contextual parameters

    • addAdvancedCriterion

      default void addAdvancedCriterion(SearchModelCriterionViewItem criterion, Map<String,Object> contextualParameters)
      Add the given criterion to the advanced criteria
      Parameters:
      criterion - the criterion to add
      contextualParameters - the contextual parameters

    • getPageSize

      int getPageSize(Map<String,Object> contextualParameters)
      Get the page size.
      Parameters:
      contextualParameters - the contextual parameters.
      Returns:
      The page size, unlimited or default used when negative or 0.

    • getSearchUrl

      String getSearchUrl(Map<String,Object> contextualParameters)
      Get the URL for search
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      the URL for search

    • getSearchUrlPlugin

      String getSearchUrlPlugin(Map<String,Object> contextualParameters)
      Get the plugin name for search
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      the plugin name for search

    • getExportCSVUrl

      String getExportCSVUrl(Map<String,Object> contextualParameters)
      Get the URL for CSV export of results
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      the URL for CSV export

    • getExportCSVUrlPlugin

      String getExportCSVUrlPlugin(Map<String,Object> contextualParameters)
      Get the plugin name for CSV export of results
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      the plugin name for CSV export

    • getPrintUrl

      String getPrintUrl(Map<String,Object> contextualParameters)
      Get the URL for print results
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      the URL for print results

    • getPrintUrlPlugin

      String getPrintUrlPlugin(Map<String,Object> contextualParameters)
      Get the plugin name for print results
      Parameters:
      contextualParameters - the contextual parameters
      Returns:
      the plugin name for print results

    • getSummaryView

      String getSummaryView()
      Get the name of the view to use for summary of the content.
      Returns:
      the name of the view to use for summary of the content. Can be null.

    • hasTag

      boolean hasTag(String tagName)
      Determines if the search model has the given tag
      Parameters:
      tagName - The tag name
      Returns:
      true if the search model is tagged with the given tag name

    • getTags

      Set<String> getTags()
      Get the registered tags for this search model
      Returns:
      the tags

    • isPublic

      default boolean isPublic()
      Get whether the search model is public
      Returns:
      true if the model is public, false if it is private.