|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.query.PagingRequest
org.alfresco.util.ScriptPagingDetails
public class ScriptPagingDetails
A simple paging details wrapper, to hold things like the
skip count, max items and total items. This is typically
used with Scripts and WebScripts, and feeds into the
Repository level paging support.
This class is typically used with ModelUtil
.
Note that org.alfresco.repo.web.paging.Paging
provides an alternate solution for other paging
use cases.
TODO Set a value for PagingRequest.setRequestTotalCountMax(int)
Nested Class Summary | |
---|---|
static class |
ScriptPagingDetails.ItemsSizeConfidence
|
Constructor Summary | |
---|---|
ScriptPagingDetails()
|
|
ScriptPagingDetails(int maxItems,
int skipCount)
|
|
ScriptPagingDetails(int maxItems,
int skipCount,
java.lang.String queryExecutionId)
|
Method Summary | |
---|---|
ScriptPagingDetails.ItemsSizeConfidence |
getConfidence()
|
int |
getTotalItems()
Get the total number of items. |
int |
getTotalItemsRangeMax()
Where the confidence is ScriptPagingDetails.ItemsSizeConfidence.RANGE , returns
the upper bound of the range. |
void |
setMaxItems(int maxItems)
|
void |
setQueryExecutionId(java.lang.String queryExecutionId)
|
void |
setSkipCount(int skipCount)
|
void |
setTotalItems(int totalItems)
Records the total number of items that were found. |
void |
setTotalItems(org.alfresco.query.PagingResults results)
Records the total number of results found, and the confidence in this, from the Paging Results |
Methods inherited from class org.alfresco.query.PagingRequest |
---|
getMaxItems, getQueryExecutionId, getRequestTotalCountMax, getSkipCount, setRequestTotalCountMax |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ScriptPagingDetails()
public ScriptPagingDetails(int maxItems, int skipCount)
public ScriptPagingDetails(int maxItems, int skipCount, java.lang.String queryExecutionId)
Method Detail |
---|
public ScriptPagingDetails.ItemsSizeConfidence getConfidence()
public int getTotalItems()
ScriptPagingDetails.getConfidence()
for an idea
of the accuracy/confidence on this value.
public void setTotalItems(int totalItems)
ScriptPagingDetails.ItemsSizeConfidence.UNKNOWN
, otherwise
the confidence is ScriptPagingDetails.ItemsSizeConfidence.EXACT
totalItems
- The total number of items the search foundpublic void setTotalItems(org.alfresco.query.PagingResults results)
results
- The PagingResults to extract the information frompublic int getTotalItemsRangeMax()
ScriptPagingDetails.ItemsSizeConfidence.RANGE
, returns
the upper bound of the range.
public void setMaxItems(int maxItems)
setMaxItems
in class org.alfresco.query.PagingRequest
public void setSkipCount(int skipCount)
setSkipCount
in class org.alfresco.query.PagingRequest
public void setQueryExecutionId(java.lang.String queryExecutionId)
setQueryExecutionId
in class org.alfresco.query.PagingRequest
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |