Nuxeo ECM Projects 5.6-RC1

org.nuxeo.cm.core.persister
Class CaseDocumentPageProvider

java.lang.Object
  extended by org.nuxeo.ecm.platform.query.api.AbstractPageProvider<DocumentModel>
      extended by org.nuxeo.ecm.platform.query.nxql.CoreQueryDocumentPageProvider
          extended by org.nuxeo.cm.core.persister.CaseDocumentPageProvider
All Implemented Interfaces:
Serializable, PageProvider<DocumentModel>

public class CaseDocumentPageProvider
extends CoreQueryDocumentPageProvider

CaseDocumentPageProvider fetch case children using Case adapter or CaseItem children using CoreSession API.

Since:
1.8
Author:
Laurent Doguin
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.nuxeo.ecm.platform.query.nxql.CoreQueryDocumentPageProvider
CHECK_QUERY_CACHE_PROPERTY, CORE_SESSION_PROPERTY, DEFAULT_NAVIGATION_RESULTS_KEY, DEFAULT_NAVIGATION_RESULTS_PROPERTY, DEFAULT_NAVIGATION_RESULTS_VALUE, MAX_RESULTS_PROPERTY, PAGE_SIZE_RESULTS_KEY
 
Fields inherited from interface org.nuxeo.ecm.platform.query.api.PageProvider
DEFAULT_MAX_PAGE_SIZE, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY
 
Constructor Summary
CaseDocumentPageProvider()
           
 
Method Summary
 List<DocumentModel> getCurrentPage()
          Returns the current page of results.
 
Methods inherited from class org.nuxeo.ecm.platform.query.nxql.CoreQueryDocumentPageProvider
getCurrentQuery, getCurrentSelectPage, getMaxResults, refresh, setMaxResults
 
Methods inherited from class org.nuxeo.ecm.platform.query.api.AbstractPageProvider
addSortInfo, firstPage, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getDefinition, getError, getErrorMessage, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageSize, getParameters, getProperties, getResultsCount, 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, toString, wait, wait, wait
 

Constructor Detail

CaseDocumentPageProvider

public CaseDocumentPageProvider()
Method Detail

getCurrentPage

public List<DocumentModel> 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<DocumentModel>
Overrides:
getCurrentPage in class CoreQueryDocumentPageProvider
Returns:
the current page

Nuxeo ECM Projects 5.6-RC1

Copyright © 2012 Nuxeo SA. All Rights Reserved.