org.alfresco.query

Interface CannedQueryFactory

All Known Implementing Classes:

AbstractCachingCannedQueryFactory, AbstractCannedQueryFactory

public interface CannedQueryFactory

Interface for factory implementations for producing instances of CannedQuery based on all the query parameters.

Since:

4.0

Method Summary

Methods

Modifier and Type	Method and Description
CannedQuery	getCannedQuery(CannedQueryParameters parameters) Retrieve an instance of a CannedQuery based on the full range of available parameters.
CannedQuery	getCannedQuery(java.lang.Object parameterBean, int skipResults, int pageSize, java.lang.String queryExecutionId) Retrieve an instance of a CannedQuery based on limited parameters.

Method Detail

getCannedQuery

CannedQuery getCannedQuery(CannedQueryParameters parameters)

Retrieve an instance of a CannedQuery based on the full range of available parameters.

Parameters:

parameters - the full query parameters

Returns:

an implementation that will execute the query

getCannedQuery

CannedQuery getCannedQuery(java.lang.Object parameterBean,
                         int skipResults,
                         int pageSize,
                         java.lang.String queryExecutionId)

Retrieve an instance of a CannedQuery based on limited parameters.

Parameters:

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

skipResults - results to skip before page

pageSize - the size of page - ie. max items (if skipResults = 0)

queryExecutionId - ID of a previously-executed query to be used during follow-up page requests - null if not available

Returns:

an implementation that will execute the query