|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.query.CannedQueryPageDetails
public class CannedQueryPageDetails
Details for canned queries supporting paged results.
Results areskipped
, chopped into pages of
appropriate size
before the start page
and number
are returned.
Field Summary | |
---|---|
static int |
DEFAULT_PAGE_COUNT
|
static int |
DEFAULT_PAGE_NUMBER
|
static int |
DEFAULT_PAGE_SIZE
|
static int |
DEFAULT_SKIP_RESULTS
|
Constructor Summary | |
---|---|
CannedQueryPageDetails()
Construct with defaults skipResults: CannedQueryPageDetails.DEFAULT_SKIP_RESULTS
pageSize: CannedQueryPageDetails.DEFAULT_PAGE_SIZE
pageNumber: CannedQueryPageDetails.DEFAULT_PAGE_NUMBER
pageCount: CannedQueryPageDetails.DEFAULT_PAGE_COUNT
|
|
CannedQueryPageDetails(int skipResults,
int pageSize)
Construct with defaults pageNumber: CannedQueryPageDetails.DEFAULT_PAGE_NUMBER
pageCount: CannedQueryPageDetails.DEFAULT_PAGE_COUNT
|
|
CannedQueryPageDetails(int skipResults,
int pageSize,
int pageNumber,
int pageCount)
|
|
CannedQueryPageDetails(PagingRequest pagingRequest)
Helper constructor to transform a paging request into the Canned Query form. |
Method Summary | |
---|---|
int |
getPageCount()
Get the total number of pages to return |
int |
getPageNumber()
Get the first page number to return |
int |
getPageSize()
Get the size of each page |
int |
getResultsRequiredForPaging()
Calculate the number of results that would be required to satisy this paging request. |
int |
getSkipResults()
Get the number of query results to skip before applying further page parameters |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_SKIP_RESULTS
public static final int DEFAULT_PAGE_SIZE
public static final int DEFAULT_PAGE_NUMBER
public static final int DEFAULT_PAGE_COUNT
Constructor Detail |
---|
public CannedQueryPageDetails()
CannedQueryPageDetails.DEFAULT_SKIP_RESULTS
CannedQueryPageDetails.DEFAULT_PAGE_SIZE
CannedQueryPageDetails.DEFAULT_PAGE_NUMBER
CannedQueryPageDetails.DEFAULT_PAGE_COUNT
public CannedQueryPageDetails(int skipResults, int pageSize)
CannedQueryPageDetails.DEFAULT_PAGE_NUMBER
CannedQueryPageDetails.DEFAULT_PAGE_COUNT
skipResults
- results to skip before page one
(default CannedQueryPageDetails.DEFAULT_SKIP_RESULTS
)pageSize
- the size of each page
(default CannedQueryPageDetails.DEFAULT_PAGE_SIZE
)public CannedQueryPageDetails(int skipResults, int pageSize, int pageNumber, int pageCount)
skipResults
- results to skip before page one
(default CannedQueryPageDetails.DEFAULT_SKIP_RESULTS
)pageSize
- the size of each page
(default CannedQueryPageDetails.DEFAULT_PAGE_SIZE
)pageNumber
- the first page number to return
(default CannedQueryPageDetails.DEFAULT_PAGE_NUMBER
)pageCount
- the number of pages to return
(default CannedQueryPageDetails.DEFAULT_PAGE_COUNT
)public CannedQueryPageDetails(PagingRequest pagingRequest)
pagingRequest
- the paging detailsMethod Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public int getSkipResults()
public int getPageSize()
public int getPageNumber()
public int getPageCount()
public int getResultsRequiredForPaging()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |