org.alfresco.util
Class ScriptPagingDetails

java.lang.Object
  extended by org.alfresco.query.PagingRequest
      extended by org.alfresco.util.ScriptPagingDetails

public class ScriptPagingDetails
extends org.alfresco.query.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.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

ScriptPagingDetails

public ScriptPagingDetails()

ScriptPagingDetails

public ScriptPagingDetails(int maxItems,
                           int skipCount)

ScriptPagingDetails

public ScriptPagingDetails(int maxItems,
                           int skipCount,
                           java.lang.String queryExecutionId)
Method Detail

getConfidence

public ScriptPagingDetails.ItemsSizeConfidence getConfidence()

getTotalItems

public int getTotalItems()
Get the total number of items. See ScriptPagingDetails.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 void setTotalItems(org.alfresco.query.PagingResults 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 org.alfresco.query.PagingRequest

setSkipCount

public void setSkipCount(int skipCount)
Overrides:
setSkipCount in class org.alfresco.query.PagingRequest

setQueryExecutionId

public void setQueryExecutionId(java.lang.String queryExecutionId)
Overrides:
setQueryExecutionId in class org.alfresco.query.PagingRequest


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.