Package org.nuxeo.ecm.platform.query.api

Interface PageProviderDefinition

All Superinterfaces:
Descriptor
All Known Implementing Classes:
CoreQueryPageProviderDescriptor, GenericPageProviderDescriptor, PageProviderDefinitionBuilder.PageProviderDefinitionImpl, SearchServicePageProviderDescriptor
public interface PageProviderDefinition extends Descriptor
Page provider descriptor interface handling all attributes common to a PageProvider generation.
Since:
5.4
Author:
Anahide Tchertchian

  • Method Details

    • getId

      default String getId()
      Description copied from interface: Descriptor
      The descriptor id, descriptors with same id are merged.

      To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

      To forbid merge use a unique value, non-overriden toString() for exemple.

      Specified by:
      getId in interface Descriptor
      Since:
      2025.0

    • 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

      PageProviderDefinition clone()
      Since:
      5.6

    • getAggregates

      List<AggregateDefinition> getAggregates()
      Since:
      6.0

    • isUsageTrackingEnabled

      boolean isUsageTrackingEnabled()
      Since:
      7.4

    • getQuickFilters

      List<QuickFilter> getQuickFilters()
      Since:
      8.4

    • builder

      default PageProviderDefinitionBuilder builder()
      Since:
      2025.0