Interface PageProviderDefinition

All Known Implementing Classes:
CoreQueryPageProviderDescriptor, GenericPageProviderDescriptor

public interface PageProviderDefinition
Page provider descriptor interface handling all attributes common to a PageProvider generation.
Since:
5.4
Author:
Anahide Tchertchian
  • Method Details

    • getName

      String getName()
    • setName

      void setName(String name)
      Since:
      6.0
    • isEnabled

      boolean isEnabled()
    • setEnabled

      void setEnabled(boolean enabled)
      Since:
      5.6
    • getProperties

      Map<String,String> getProperties()
    • getQueryParameters

      String[] getQueryParameters()
    • getQuotePatternParameters

      boolean getQuotePatternParameters()
    • getEscapePatternParameters

      boolean getEscapePatternParameters()
    • setPattern

      void setPattern(String pattern)
    • getPattern

      String getPattern()
    • getWhereClause

      WhereClauseDefinition getWhereClause()
    • getSearchDocumentType

      String getSearchDocumentType()
      Returns the search document type used for wher clause, aggregates and named parameters.
      Since:
      6.0
    • isSortable

      boolean isSortable()
    • getSortInfos

      List<SortInfo> getSortInfos()
    • getSortInfosBinding

      String getSortInfosBinding()
    • getPageSize

      long getPageSize()
    • getPageSizeBinding

      String getPageSizeBinding()
    • getMaxPageSize

      Long getMaxPageSize()
    • getPageSizeOptions

      List<Long> getPageSizeOptions()
      Returns the list of page size options to present to users.

      Uses an hardcoded list of values, and adds up the page provider initial page size to it.

      Since:
      7.3
    • clone

      Since:
      5.6
    • getAggregates

      List<AggregateDefinition> getAggregates()
      Since:
      6.0
    • isUsageTrackingEnabled

      boolean isUsageTrackingEnabled()
      Since:
      7.4
    • getQuickFilters

      List<QuickFilter> getQuickFilters()
      Since:
      8.4