Package org.nuxeo.ecm.platform.query.core

Class BasePageProviderDescriptor

java.lang.Object
org.nuxeo.ecm.platform.query.core.BasePageProviderDescriptor
Direct Known Subclasses:
CoreQueryPageProviderDescriptor, GenericPageProviderDescriptor
public abstract class BasePageProviderDescriptor extends Object
Base class for page provider descriptors.
Since:
6.0

  • Field Details

    • name

      protected String name

    • enabled

      protected boolean enabled

    • properties

      protected Map<String,String> properties

    • queryParameters

      protected String[] queryParameters

    • pageSize

      protected long pageSize

    • pageSizeBinding

      protected String pageSizeBinding

    • maxPageSize

      protected Long maxPageSize

    • pageSizeOptions

      protected List<Long> pageSizeOptions
      Since:
      7.3

    • sortable

      protected boolean sortable

    • sortInfos

      protected List<SortInfoDescriptor> sortInfos

    • sortInfosBinding

      protected String sortInfosBinding

    • pattern

      protected String pattern

    • quotePatternParameters

      protected boolean quotePatternParameters

    • escapePatternParameters

      protected boolean escapePatternParameters

    • whereClause

      protected WhereClauseDescriptor whereClause

    • searchDocumentType

      protected String searchDocumentType
      Since:
      6.0

    • quickFilters

      protected List<QuickFilterDescriptor> quickFilters
      Since:
      8.4

    • aggregates

      protected List<AggregateDescriptor> aggregates
      Since:
      6.0

    • trackUsage

      protected boolean trackUsage
      Since:
      7.4

  • Constructor Details

    • BasePageProviderDescriptor

      public BasePageProviderDescriptor()

  • Method Details

    • setPattern

      public void setPattern(String pattern)

    • isUsageTrackingEnabled

      public boolean isUsageTrackingEnabled()
      Since:
      7.4

    • getQuotePatternParameters

      public boolean getQuotePatternParameters()

    • getEscapePatternParameters

      public boolean getEscapePatternParameters()

    • getProperties

      public Map<String,String> getProperties()

    • getQueryParameters

      public String[] getQueryParameters()

    • getPattern

      public String getPattern()

    • getWhereClause

      public WhereClauseDefinition getWhereClause()

    • getQuickFilters

      public List<QuickFilter> getQuickFilters()
      Since:
      8.4

    • isSortable

      public boolean isSortable()

    • getSortInfos

      public List<SortInfo> getSortInfos()

    • getPageSize

      public long getPageSize()

    • getPageSizeOptions

      public List<Long> getPageSizeOptions()

    • isEnabled

      public boolean isEnabled()

    • setEnabled

      public void setEnabled(boolean enabled)

    • getPageSizeBinding

      public String getPageSizeBinding()

    • getSortInfosBinding

      public String getSortInfosBinding()

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getMaxPageSize

      public Long getMaxPageSize()

    • setQuotePatternParameters

      public void setQuotePatternParameters(boolean quotePatternParameters)
      Since:
      7.10

    • setEscapePatternParameters

      public void setEscapePatternParameters(boolean escapePatternParameters)
      Since:
      7.10

    • getAggregates

      public List<AggregateDefinition> getAggregates()
      Since:
      6.0

    • getSearchDocumentType

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

    • cloneDescriptor

      protected BasePageProviderDescriptor cloneDescriptor()

    • newInstance

      protected abstract BasePageProviderDescriptor newInstance()