Package org.ametys.plugins.workspaces.search

Interface SearchModule

All Known Implementing Classes:
StaticSearchModule
public interface SearchModule
Interface for search module

  • Method Details

    • getId

      String getId()
      Get the id
      Returns:
      the id

    • getTitle

      I18nizableText getTitle()
      Get the title of the search
      Returns:
      title of the module

    • getSearchUrl

      String getSearchUrl()
      Get the search url
      Returns:
      URL to fetch for search

    • getLimit

      int getLimit()
      Get the number of results per page
      Returns:
      Max number of results on the module view

    • getMinLimit

      int getMinLimit()
      Get the number of results per page on the main page (should be smaller than getLimit())
      Returns:
      Max number of results on the main view

    • getOrder

      int getOrder()
      Get the module order, smaller order means that it is displayed before
      Returns:
      The module order value

    • getReferenceModuleId

      String getReferenceModuleId()
      Get the id of workspace module this search module is related to.
      Returns:
      the id of linked module or null if not related to a workspace module.