PageProviderDefinition (Nuxeo ECM Projects 9.10-SNAPSHOT API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

CoreQueryPageProviderDescriptor, GenericPageProviderDescriptor
```
public interface PageProviderDefinition
extends Serializable
```
Page provider descriptor interface handling all attributes common to a PageProvider generation.

Since:

5.4

Author:

Anahide Tchertchian

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PageProviderDefinition`	`clone()`
`List<AggregateDefinition>`	`getAggregates()`
`boolean`	`getEscapePatternParameters()`
`Long`	`getMaxPageSize()`
`String`	`getName()`
`long`	`getPageSize()`
`String`	`getPageSizeBinding()`
`List<Long>`	`getPageSizeOptions()` Returns the list of page size options to present to users.
`String`	`getPattern()`
`Map<String,String>`	`getProperties()`
`String[]`	`getQueryParameters()`
`List<QuickFilter>`	`getQuickFilters()`
`boolean`	`getQuotePatternParameters()`
`String`	`getSearchDocumentType()` Returns the search document type used for wher clause, aggregates and named parameters.
`List<SortInfo>`	`getSortInfos()`
`String`	`getSortInfosBinding()`
`WhereClauseDefinition`	`getWhereClause()`
`boolean`	`isEnabled()`
`boolean`	`isSortable()`
`boolean`	`isUsageTrackingEnabled()`
`void`	`setEnabled(boolean enabled)`
`void`	`setName(String name)`
`void`	`setPattern(String pattern)`

Method Detail

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

Interface PageProviderDefinition

Method Summary

Method Detail

getName

setName

isEnabled

setEnabled

getProperties

getQueryParameters

getQuotePatternParameters

getEscapePatternParameters

setPattern

getPattern

getWhereClause

getSearchDocumentType

isSortable

getSortInfos

getSortInfosBinding

getPageSize

getPageSizeBinding

getMaxPageSize

getPageSizeOptions

clone

getAggregates

isUsageTrackingEnabled

getQuickFilters