org.alfresco.query

Class CannedQueryParameters

java.lang.Object

org.alfresco.query.CannedQueryParameters

public class CannedQueryParameters
extends java.lang.Object

Parameters defining the 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.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TOTAL_COUNT_MAX

Constructor Summary

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
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

DEFAULT_TOTAL_COUNT_MAX

public static final int DEFAULT_TOTAL_COUNT_MAX

See Also:

Constant Field Values

Constructor Detail

CannedQueryParameters

public CannedQueryParameters(java.lang.Object parameterBean)

• pageDetails: null
• sortDetails: null
• totalResultCountMax: 0
• queryExecutionId: null

See Also:

#NamedQueryParameters(Object, CannedQueryPageDetails, CannedQuerySortDetails, String, int, String)

CannedQueryParameters

public CannedQueryParameters(java.lang.Object parameterBean,
                     int skipResults,
                     int pageSize,
                     java.lang.String queryExecutionId)

Defaults:

• pageDetails.pageNumber: 1
• pageDetails.pageCount: 1
• totalResultCountMax: 0

See Also:

#NamedQueryParameters(Object, CannedQueryPageDetails, CannedQuerySortDetails, String, int, String)

CannedQueryParameters

public CannedQueryParameters(java.lang.Object parameterBean,
                     CannedQueryPageDetails pageDetails,
                     CannedQuerySortDetails sortDetails)

Defaults:

• totalResultCountMax: 0
• queryExecutionId: null

See Also:

#NamedQueryParameters(Object, CannedQueryPageDetails, CannedQuerySortDetails, String, int, String)

CannedQueryParameters

public CannedQueryParameters(java.lang.Object parameterBean,
                     CannedQuerySortDetails sortDetails,
                     PagingRequest pagingRequest)

Construct all the parameters for executing a named query, using values from the PagingRequest.

Parameters:

parameterBean - the values that the query will be based on or null if not relevant to the query

sortDetails - the type of sorting to be applied or null for none

pageRequest - the type of paging to be applied or null for none

CannedQueryParameters

public CannedQueryParameters(java.lang.Object parameterBean,
                     CannedQueryPageDetails pageDetails,
                     CannedQuerySortDetails sortDetails,
                     int totalResultCountMax,
                     java.lang.String queryExecutionId)

Construct all the parameters for executing a named query. Note that the allowable values for the arguments depend on the specific query being executed.

Parameters:

parameterBean - the values that the query will be based on or null if not relevant to the query

pageDetails - the type of paging to be applied or null for none

sortDetails - the type of sorting to be applied or null for none

totalResultCountMax - 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 available

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getQueryExecutionId

public java.lang.String getQueryExecutionId()

getSortDetails

public CannedQuerySortDetails getSortDetails()

Returns:

the sort details (never null)

getPageDetails

public CannedQueryPageDetails getPageDetails()

Returns:

the query paging details (never null)

getTotalResultCountMax

public int getTotalResultCountMax()

Returns:

if > 0 then the query should not only return the required rows but should also return the total count (number of possible rows) up to the given max if 0 then query does not need to return the total count

getResultsRequired

public 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 ... and an extra to provide 'hasMore' functionality.

Returns:

the minimum number of results required before pages can be created

getParameterBean

public java.lang.Object getParameterBean()

Returns:

parameterBean the values that the query will be based on or null if not relevant to the query