org.nuxeo.ecm.platform.audit.api
Class AuditPageProvider

java.lang.Object
  org.nuxeo.ecm.platform.query.api.AbstractPageProvider<LogEntry>
      org.nuxeo.ecm.platform.audit.api.AuditPageProvider

All Implemented Interfaces:

Serializable, PageProvider<LogEntry>

public class AuditPageProvider
extends AbstractPageProvider<LogEntry>
implements PageProvider<LogEntry>

PageProvider implementation that returns LogEntry from Audit Service

Since:

5.4.2

Author:

Tiry (tdelprat@nuxeo.com)

See Also:

Serialized Form

Field Summary

static String	CORE_SESSION_PROPERTY
static String	UICOMMENTS_PROPERTY

Fields inherited from interface org.nuxeo.ecm.platform.query.api.PageProvider

DEFAULT_MAX_PAGE_SIZE, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY

Constructor Summary

AuditPageProvider()

Method Summary

List<LogEntry>	getCurrentPage() Returns the current page of results.
long	getResultsCount() Returns the number of result elements if available or a negative value if it is unknown: UNKNOWN_SIZE if it is unknown as query was not done, and since 5.4.3, UNKNOWN_SIZE_AFTER_QUERY if it is still unknown after query was done.
void	refresh() Forces refresh of the current page.
String	toString()

Methods inherited from class org.nuxeo.ecm.platform.query.api.AbstractPageProvider

addSortInfo, firstPage, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageSize, getParameters, getProperties, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSortable, last, lastPage, next, nextEntry, nextPage, previous, previousEntry, previousPage, rewind, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.platform.query.api.PageProvider

addSortInfo, firstPage, getCurrentEntry, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefinition, getError, getErrorMessage, getMaxPageSize, getName, getNumberOfPages, getPageSize, getParameters, getProperties, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasError, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isSortable, lastPage, nextEntry, nextPage, previousEntry, previousPage, setCurrentEntry, setCurrentEntryIndex, setCurrentPage, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageSize, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos

Field Detail

CORE_SESSION_PROPERTY

public static final String CORE_SESSION_PROPERTY

See Also:

Constant Field Values

UICOMMENTS_PROPERTY

public static final String UICOMMENTS_PROPERTY

See Also:

Constant Field Values

Constructor Detail

AuditPageProvider

public AuditPageProvider()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getCurrentPage

public List<LogEntry> getCurrentPage()

Description copied from interface: PageProvider

Returns the current page of results.

This method is designed to be called from higher levels. It therefore ensures cheapness of repeated calls, rather than data consistency. There is a refresh() method for that.

Specified by:

getCurrentPage in interface PageProvider<LogEntry>

Specified by:

getCurrentPage in class AbstractPageProvider<LogEntry>

Returns:

the current page

refresh

public void refresh()

Description copied from interface: PageProvider

Forces refresh of the current page.

Specified by:

refresh in interface PageProvider<LogEntry>

Overrides:

refresh in class AbstractPageProvider<LogEntry>

getResultsCount

public long getResultsCount()

Description copied from interface: PageProvider

Returns the number of result elements if available or a negative value if it is unknown: UNKNOWN_SIZE if it is unknown as query was not done, and since 5.4.3, UNKNOWN_SIZE_AFTER_QUERY if it is still unknown after query was done.

Specified by:

getResultsCount in interface PageProvider<LogEntry>

Overrides:

getResultsCount in class AbstractPageProvider<LogEntry>