Package org.alfresco.query
Interface CannedQueryFactory<R>
-
- Type Parameters:
R
- the query result type
- All Known Implementing Classes:
AbstractCachingCannedQueryFactory
,AbstractCannedQueryFactory
public interface CannedQueryFactory<R>
Interface for factory implementations for producing instances ofCannedQuery
based on all the query parameters.- Since:
- 4.0
- Author:
- Derek Hulley, janv
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CannedQuery<R>
getCannedQuery(Object parameterBean, int skipResults, int pageSize, String queryExecutionId)
Retrieve an instance of aCannedQuery
based on limited parameters.CannedQuery<R>
getCannedQuery(CannedQueryParameters parameters)
Retrieve an instance of aCannedQuery
based on the full range of available parameters.
-
-
-
Method Detail
-
getCannedQuery
CannedQuery<R> getCannedQuery(CannedQueryParameters parameters)
Retrieve an instance of aCannedQuery
based on the full range of available parameters.- Parameters:
parameters
- the full query parameters- Returns:
- an implementation that will execute the query
-
getCannedQuery
CannedQuery<R> getCannedQuery(Object parameterBean, int skipResults, int pageSize, String queryExecutionId)
Retrieve an instance of aCannedQuery
based on limited parameters.- Parameters:
parameterBean
- the values that the query will be based on or null if not relevant to the queryskipResults
- results to skip before pagepageSize
- 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
-
-