Package org.alfresco.util

Class ScriptPagingDetails

java.lang.Object

org.alfresco.query.PagingRequest

org.alfresco.util.ScriptPagingDetails

public class ScriptPagingDetails
extends PagingRequest

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.util.paging.Paging provides an alternate solution for other paging use cases. TODO Set a value for PagingRequest.setRequestTotalCountMax(int)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptPagingDetails.ItemsSizeConfidence

Constructor Summary

Constructors

Constructor	Description
ScriptPagingDetails()
ScriptPagingDetails(int maxItems, int skipCount)
ScriptPagingDetails(int maxItems, int skipCount, String queryExecutionId)
ScriptPagingDetails(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.

Method Summary

Modifier and Type	Method	Description
static 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(PagingResults<R> 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

ScriptPagingDetails

public ScriptPagingDetails()

ScriptPagingDetails

public ScriptPagingDetails(int maxItems,
                           int skipCount)

ScriptPagingDetails

public ScriptPagingDetails(int maxItems,
                           int skipCount,
                           String queryExecutionId)

ScriptPagingDetails

public ScriptPagingDetails(PagingRequest paging)

ScriptPagingDetails

public ScriptPagingDetails(org.springframework.extensions.webscripts.WebScriptRequest req,
                           int maxResultCount)
                    throws org.springframework.extensions.webscripts.WebScriptException

Creates a new PagingRequest object (in the form of ScriptPagingDetails), based on the standard URL parameters for webscript paging.

Parameters:

req - The request object to extract parameters from

maxResultCount - The maximum results count if none is specified

Throws:

org.springframework.extensions.webscripts.WebScriptException

Method Detail

buildPagingRequest

public static PagingRequest buildPagingRequest(org.springframework.extensions.webscripts.WebScriptRequest req,
                                               int maxResultCount)
                                        throws org.springframework.extensions.webscripts.WebScriptException

Creates a new PagingRequest object, based on the standard URL parameters for webscript paging.

Parameters:

req - The request object to extract parameters from

maxResultCount - The maximum results count if none is specified

Throws:

org.springframework.extensions.webscripts.WebScriptException

getConfidence

public ScriptPagingDetails.ItemsSizeConfidence getConfidence()

getTotalItems

public int getTotalItems()

Get the total number of items. See getConfidence() for an idea of the accuracy/confidence on this value.

setTotalItems

public void setTotalItems(int totalItems)

Records the total number of items that were found. If the value is -1, then the confidence is set to ScriptPagingDetails.ItemsSizeConfidence.UNKNOWN, otherwise the confidence is ScriptPagingDetails.ItemsSizeConfidence.EXACT

Parameters:

totalItems - The total number of items the search found

setTotalItems

public <R> void setTotalItems(PagingResults<R> results)

Records the total number of results found, and the confidence in this, from the Paging Results

Parameters:

results - The PagingResults to extract the information from

getTotalItemsRangeMax

public int getTotalItemsRangeMax()

Where the confidence is ScriptPagingDetails.ItemsSizeConfidence.RANGE, returns the upper bound of the range.

setMaxItems

public void setMaxItems(int maxItems)

Overrides:

setMaxItems in class PagingRequest

setSkipCount

public void setSkipCount(int skipCount)

Overrides:

setSkipCount in class PagingRequest

setQueryExecutionId

public void setQueryExecutionId(String queryExecutionId)

Overrides:

setQueryExecutionId in class PagingRequest