public class CannedQueryParameters extends Object
named query
to execute.
The implementations of the underlying queries may be vastly different
depending on seemingly-minor variations in the parameters; only set the
parameters that are required.Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_TOTAL_COUNT_MAX |
Constructor and Description |
---|
CannedQueryParameters(Object parameterBean)
pageDetails: null
sortDetails: null
totalResultCountMax: 0
queryExecutionId: null
|
CannedQueryParameters(Object parameterBean,
CannedQueryPageDetails pageDetails,
CannedQuerySortDetails sortDetails)
Defaults:
totalResultCountMax: 0
queryExecutionId: null
|
CannedQueryParameters(Object parameterBean,
CannedQueryPageDetails pageDetails,
CannedQuerySortDetails sortDetails,
int totalResultCountMax,
String queryExecutionId)
Construct all the parameters for executing a named query.
|
CannedQueryParameters(Object parameterBean,
CannedQuerySortDetails sortDetails,
PagingRequest pagingRequest)
Construct all the parameters for executing a named query, using values from the
PagingRequest . |
CannedQueryParameters(Object parameterBean,
int skipResults,
int pageSize,
String queryExecutionId)
Defaults:
pageDetails.pageNumber: 1
pageDetails.pageCount: 1
totalResultCountMax: 0
|
Modifier and Type | Method and Description |
---|---|
CannedQueryPageDetails |
getPageDetails() |
Object |
getParameterBean() |
String |
getQueryExecutionId() |
int |
getResultsRequired()
Helper method to get the total number of query results that need to be obtained in order
to satisfy the
paging requirements , the
maximum result count ... |
CannedQuerySortDetails |
getSortDetails() |
int |
getTotalResultCountMax() |
String |
toString() |
public static final int DEFAULT_TOTAL_COUNT_MAX
public CannedQueryParameters(Object parameterBean)
public CannedQueryParameters(Object parameterBean, int skipResults, int pageSize, String queryExecutionId)
public CannedQueryParameters(Object parameterBean, CannedQueryPageDetails pageDetails, CannedQuerySortDetails sortDetails)
public CannedQueryParameters(Object parameterBean, CannedQuerySortDetails sortDetails, PagingRequest pagingRequest)
PagingRequest
.parameterBean
- the values that the query will be based on or null
if not relevant to the querysortDetails
- the type of sorting to be applied or null for nonepagingRequest
- the type of paging to be applied or null for nonepublic CannedQueryParameters(Object parameterBean, CannedQueryPageDetails pageDetails, CannedQuerySortDetails sortDetails, int totalResultCountMax, String queryExecutionId)
parameterBean
- the values that the query will be based on or null
if not relevant to the querypageDetails
- the type of paging to be applied or null for nonesortDetails
- the type of sorting to be applied or null for nonetotalResultCountMax
- greater than zero if the query should not only return the required rows
but should also return the total number of possible rows up to
the given maximum.queryExecutionId
- ID of a previously-executed query to be used during follow-up
page requests - null if not availablepublic String getQueryExecutionId()
public CannedQuerySortDetails getSortDetails()
public CannedQueryPageDetails getPageDetails()
public int getTotalResultCountMax()
public int getResultsRequired()
paging requirements
, the
maximum result count ... and an extra to provide
'hasMore' functionality.public Object getParameterBean()
Copyright © 2005–2019 Alfresco Software. All rights reserved.