|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.query.CannedQueryParameters
public class CannedQueryParameters
Parameters defining the named query
to execute.
Field Summary | |
---|---|
static int |
DEFAULT_TOTAL_COUNT_MAX
|
Constructor Summary | |
---|---|
CannedQueryParameters(java.lang.Object parameterBean)
pageDetails: null sortDetails: null totalResultCountMax: 0 queryExecutionId: null |
|
CannedQueryParameters(java.lang.Object parameterBean,
CannedQueryPageDetails pageDetails,
CannedQuerySortDetails sortDetails)
Defaults: totalResultCountMax: 0 queryExecutionId: null |
|
CannedQueryParameters(java.lang.Object parameterBean,
CannedQueryPageDetails pageDetails,
CannedQuerySortDetails sortDetails,
int totalResultCountMax,
java.lang.String queryExecutionId)
Construct all the parameters for executing a named query. |
|
CannedQueryParameters(java.lang.Object parameterBean,
CannedQuerySortDetails sortDetails,
PagingRequest pagingRequest)
Construct all the parameters for executing a named query, using values from the PagingRequest . |
|
CannedQueryParameters(java.lang.Object parameterBean,
int skipResults,
int pageSize,
java.lang.String queryExecutionId)
Defaults: pageDetails.pageNumber: 1 pageDetails.pageCount: 1 totalResultCountMax: 0 |
Method Summary | |
---|---|
CannedQueryPageDetails |
getPageDetails()
|
java.lang.Object |
getParameterBean()
|
java.lang.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()
|
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_TOTAL_COUNT_MAX
Constructor Detail |
---|
public CannedQueryParameters(java.lang.Object parameterBean)
#NamedQueryParameters(Object, CannedQueryPageDetails, CannedQuerySortDetails, String, int, String)
public CannedQueryParameters(java.lang.Object parameterBean, int skipResults, int pageSize, java.lang.String queryExecutionId)
#NamedQueryParameters(Object, CannedQueryPageDetails, CannedQuerySortDetails, String, int, String)
public CannedQueryParameters(java.lang.Object parameterBean, CannedQueryPageDetails pageDetails, CannedQuerySortDetails sortDetails)
#NamedQueryParameters(Object, CannedQueryPageDetails, CannedQuerySortDetails, String, int, String)
public CannedQueryParameters(java.lang.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 nonepageRequest
- the type of paging to be applied or null for nonepublic CannedQueryParameters(java.lang.Object parameterBean, CannedQueryPageDetails pageDetails, CannedQuerySortDetails sortDetails, int totalResultCountMax, java.lang.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 availableMethod Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.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 java.lang.Object getParameterBean()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |