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

Interface SearchUIModel

    • Method Detail

      • getAdvancedCriterion

        default SearchUICriterion getAdvancedCriterion​(String id,
                                               Map<String,​Object> contextualParameters)
        Get an advanced search criterion by its id.
        Parameters:
        id - The advanced search criterion id.
        contextualParameters - the contextual parameters
        Returns:
        the advanced criterion or null if not found

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

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

      • 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

      • getExportDOCUrl

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

      • getExportDOCUrlPlugin

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

      • getExportXMLUrl

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

      • getExportXMLUrlPlugin

        String getExportXMLUrlPlugin​(Map<String,​Object> contextualParameters)
        Get the plugin name for XML export of results
        Parameters:
        contextualParameters - the contextual parameters
        Returns:
        the plugin name for XML 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.

      • allowSortOnMultipleJoin

        default boolean allowSortOnMultipleJoin()
        Indicates if sorting on join columns which contain at least one multiple metadata in its path (intermediate ones only) must be allowed.
        If the final metadata of the path is multiple, the column will not be sortable though.
        Returns:
        true if sorting on join columns which contains at least one multiple metadata in its path (intermediate ones only) must be allowed.