public interface QueryService
Modifier and Type | Method and Description |
---|---|
List<QueryDefinition> |
getQueries(org.kie.api.runtime.query.QueryContext queryContext)
Returns list of query definitions registered in the system
|
QueryDefinition |
getQuery(String uniqueQueryName)
Returns query definition details that is registered under given uniqueQueryName
|
<T> T |
query(String queryName,
QueryResultMapper<T> mapper,
org.kie.api.runtime.query.QueryContext queryContext,
QueryParam... filterParams)
Performs query on given query definition that had to be previously registered.
|
<T> T |
query(String queryName,
QueryResultMapper<T> mapper,
org.kie.api.runtime.query.QueryContext queryContext,
QueryParamBuilder<?> paramBuilder)
Performs query on given query definition that had to be previously registered.
|
void |
registerQuery(QueryDefinition queryDefinition)
Registers new query definition in the system so it can be used for executing queries on top of it.
|
void |
replaceQuery(QueryDefinition queryDefinition)
Registers or replaces existing query.
|
void |
unregisterQuery(String uniqueQueryName)
Removes the query definition from the system
|
void registerQuery(QueryDefinition queryDefinition) throws QueryAlreadyRegisteredException
queryDefinition
- definition of the query to be registeredQueryAlreadyRegisteredException
- in case there is already query registered with given name (queryDefinition.getName())void replaceQuery(QueryDefinition queryDefinition)
registerQuery
does, though it won't throw
exception in case there is already query registered but simply replace it.queryDefinition
- definition of the query to be registered/replacedvoid unregisterQuery(String uniqueQueryName) throws QueryNotFoundException
uniqueQueryName
- unique name that query was registered underQueryNotFoundException
- in case there is no such query registeredQueryDefinition getQuery(String uniqueQueryName) throws QueryNotFoundException
uniqueQueryName
- unique name that query was registered underQueryNotFoundException
- in case there is no such query registeredList<QueryDefinition> getQueries(org.kie.api.runtime.query.QueryContext queryContext)
queryContext
- provides pagnition information for the query<T> T query(String queryName, QueryResultMapper<T> mapper, org.kie.api.runtime.query.QueryContext queryContext, QueryParam... filterParams) throws QueryNotFoundException
mapper
and:
queryContext
filterParams
if givenqueryName
- unique name that query was registered undermapper
- type of the QueryResultMapper
to map raw data set into list of objectsqueryContext
- query context carrying paging and sorting detailsfilterParams
- additional filter parameters to narrow down the resultQueryNotFoundException
- in case there is no such query registered<T> T query(String queryName, QueryResultMapper<T> mapper, org.kie.api.runtime.query.QueryContext queryContext, QueryParamBuilder<?> paramBuilder) throws QueryNotFoundException
mapper
and:
queryContext
paramBuilder
which
is an implementation of QueryParamBuilder
for building advanced filtersqueryName
- unique name that query was registered undermapper
- type of the QueryResultMapper
to map raw data set into list of objectsqueryContext
- query context carrying paging and sorting detailsparamBuilder
- implementation of QueryParamBuilder
that allows to build custom filters in advanced wayQueryNotFoundException
- in case there is no such query registeredCopyright © 2001–2020 JBoss by Red Hat. All rights reserved.