Class DocumentHistoryPageProvider
java.lang.Object
org.nuxeo.ecm.platform.query.api.AbstractPageProvider<LogEntry>
org.nuxeo.ecm.platform.audit.api.AuditPageProvider
org.nuxeo.ecm.platform.audit.api.document.DocumentHistoryPageProvider
- All Implemented Interfaces:
Serializable
,PageProvider<LogEntry>
Page provider that is dedicated to fetching history of a Document.
Because of the way the Audit log is stored (i.e. mainly stores events related to the live document), retrieving history of a version or of a proxy requires some additional processing.
This PageProvider
does not accept a fixed part in the whereclause because it is automatically build by the
provider itself. This PageProvider
expect to have :
- DocumentModel or UUID as input parameter
- CoreSession as property (only used if input parameter is an uuid)
- Author:
- Tiry
- See Also:
-
Field Summary
Fields inherited from class org.nuxeo.ecm.platform.audit.api.AuditPageProvider
auditQuery, auditQueryParams, CORE_SESSION_PROPERTY, UICOMMENTS_PROPERTY
Fields inherited from class org.nuxeo.ecm.platform.query.api.AbstractPageProvider
currentEntryIndex, currentHigherNonEmptyPageIndex, currentSelectPage, definition, error, errorMessage, highlights, maxPageSize, name, offset, PAGEPROVIDER_TRACK_PROPERTY_NAME, pageProviderChangedListener, pageSize, pageSizeOptions, parameters, properties, quickFilters, resultsCount, searchDocumentModel, selectedEntries, SKIPPED_SCHEMAS_FOR_SEARCHFIELD, sortable, sortInfos, tracking
Fields inherited from interface org.nuxeo.ecm.platform.query.api.PageProvider
DEFAULT_MAX_PAGE_SIZE, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, HIGHLIGHT_CTX_DATA, PAGE_LIMIT_UNKNOWN, SKIP_AGGREGATES_PROP, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
protected String
Object[]
Returns the complete list of sorting info for this providerboolean
hasChangedParameters
(Object[] parameters) Test if provider parameters have changedMethods inherited from class org.nuxeo.ecm.platform.audit.api.AuditPageProvider
buildAuditQuery, convertParam, getCurrentPage, getResultsCount, getSortPart, isNonNullParam, preprocessCommentsIfNeeded, refresh, toString
Methods inherited from class org.nuxeo.ecm.platform.query.api.AbstractPageProvider
addQuickFilter, addSortInfo, fireSearchEvent, firstPage, getAggregateDefinitions, getAggregates, getAvailableQuickFilters, getBooleanProperty, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefaultMaxPageSize, getDefinition, getError, getErrorMessage, getHighlights, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getPageSizeOptions, getParametersChanged, getProperties, getQuickFilters, getResultsCountLimit, getSearchDocumentModel, getSortInfo, getSortInfoIndex, hasAggregateSupport, hasError, incorporateAggregates, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSkipAggregates, isSortable, isTrackingEnabled, lastPage, nextEntry, nextPage, notifyPageChanged, notifyRefresh, pageChanged, previousEntry, previousPage, searchDocumentModelChanged, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setHighlights, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setPageSizeOptions, setParameters, setProperties, setQuickFilters, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos, sortInfoChanged
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.nuxeo.ecm.platform.query.api.PageProvider
addQuickFilter, addSortInfo, firstPage, getAggregateDefinitions, getAggregates, getAvailableQuickFilters, getCurrentEntry, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getHighlights, getMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getPageSizeOptions, getProperties, getQuickFilters, getResultsCountLimit, getSearchDocumentModel, getSortInfo, getSortInfoIndex, hasAggregateSupport, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSkipAggregates, isSortable, lastPage, nextEntry, nextPage, previousEntry, previousPage, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setHighlights, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setPageSizeOptions, setParameters, setProperties, setQuickFilters, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos
-
Field Details
-
newParams
-
-
Constructor Details
-
DocumentHistoryPageProvider
public DocumentHistoryPageProvider()
-
-
Method Details
-
getFixedPart
- Overrides:
getFixedPart
in classAuditPageProvider
-
allowSimplePattern
protected boolean allowSimplePattern()- Overrides:
allowSimplePattern
in classAuditPageProvider
-
getSortInfos
Description copied from interface:PageProvider
Returns the complete list of sorting info for this provider- Specified by:
getSortInfos
in interfacePageProvider<LogEntry>
- Overrides:
getSortInfos
in classAbstractPageProvider<LogEntry>
-
getParameters
- Specified by:
getParameters
in interfacePageProvider<LogEntry>
- Overrides:
getParameters
in classAbstractPageProvider<LogEntry>
-
hasChangedParameters
Description copied from interface:PageProvider
Test if provider parameters have changed- Specified by:
hasChangedParameters
in interfacePageProvider<LogEntry>
- Overrides:
hasChangedParameters
in classAbstractPageProvider<LogEntry>
-