Package org.ametys.plugins.workspaces.search

Interface SearchModule

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    Get the id
    int
    getLimit()
    Get the number of results per page
    int
    getMinLimit()
    Get the number of results per page on the main page (should be smaller than getLimit())
    int
    getOrder()
    Get the module order, smaller order means that it is displayed before
    String
    getSearchUrl()
    Get the search url
    I18nizableText
    getTitle()
    Get the title of the search

  • 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