public class ScriptPagingDetails
extends org.alfresco.query.PagingRequest
ModelUtil
.
Note that Paging
provides an alternate solution for other paging
use cases.
TODO Set a value for PagingRequest.setRequestTotalCountMax(int)
Modifier and Type | Class and Description |
---|---|
static class |
ScriptPagingDetails.ItemsSizeConfidence |
Constructor and Description |
---|
ScriptPagingDetails() |
ScriptPagingDetails(int maxItems,
int skipCount) |
ScriptPagingDetails(int maxItems,
int skipCount,
String queryExecutionId) |
ScriptPagingDetails(org.alfresco.query.PagingRequest paging) |
ScriptPagingDetails(org.springframework.extensions.webscripts.WebScriptRequest req,
int maxResultCount)
Creates a new
PagingRequest object (in the form of
ScriptPagingDetails ), based on the standard URL
parameters for webscript paging. |
Modifier and Type | Method and Description |
---|---|
static org.alfresco.query.PagingRequest |
buildPagingRequest(org.springframework.extensions.webscripts.WebScriptRequest req,
int maxResultCount)
Creates a new
PagingRequest object, based on the standard URL
parameters for webscript paging. |
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(String queryExecutionId) |
void |
setSkipCount(int skipCount) |
void |
setTotalItems(int totalItems)
Records the total number of items that were found.
|
<R> void |
setTotalItems(org.alfresco.query.PagingResults<R> results)
Records the total number of results found, and the confidence
in this, from the Paging Results
|
public ScriptPagingDetails()
public ScriptPagingDetails(int maxItems, int skipCount)
public ScriptPagingDetails(int maxItems, int skipCount, String queryExecutionId)
public ScriptPagingDetails(org.alfresco.query.PagingRequest paging)
public ScriptPagingDetails(org.springframework.extensions.webscripts.WebScriptRequest req, int maxResultCount) throws org.springframework.extensions.webscripts.WebScriptException
PagingRequest
object (in the form of
ScriptPagingDetails
), based on the standard URL
parameters for webscript paging.req
- The request object to extract parameters frommaxResultCount
- The maximum results count if none is specifiedorg.springframework.extensions.webscripts.WebScriptException
public static org.alfresco.query.PagingRequest buildPagingRequest(org.springframework.extensions.webscripts.WebScriptRequest req, int maxResultCount) throws org.springframework.extensions.webscripts.WebScriptException
PagingRequest
object, based on the standard URL
parameters for webscript paging.req
- The request object to extract parameters frommaxResultCount
- The maximum results count if none is specifiedorg.springframework.extensions.webscripts.WebScriptException
public ScriptPagingDetails.ItemsSizeConfidence getConfidence()
public int getTotalItems()
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 <R> void setTotalItems(org.alfresco.query.PagingResults<R> 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(String queryExecutionId)
setQueryExecutionId
in class org.alfresco.query.PagingRequest
Copyright © 2005–2017 Alfresco Software. All rights reserved.