com.sdl.web.api.broker.querying.generators.service

Interface BrokerQueryService

public interface BrokerQueryService

This is the BrokerQueryService responsible for executing the broker query. It will accept as input the Query Object Model. and use this to execute against the underlying storage service.

Method Summary

Modifier and Type	Method and Description
BrokerQueryResult	executeQuery(BrokerQueryConstructor queryConstructor, BrokerResultFilter resultFilter) This executes the actual broker query based on the constructed query and resultFilter.
BrokerQueryResult	executeQuery(String selectField, BrokerCriteria criteria, BrokerSorting sorting, BrokerResultFilter resultFilter) This executes the actual broker query based on the given criteria, sorting and filter.
BrokerQueryConstructor	generateQuery(String selectField, BrokerCriteria criteria, BrokerSorting sorting) This generates the main broker query needed to execute the JPQL query.
String	getStorageId() Returns the storageId that the queryService will query.

Method Detail

executeQuery

BrokerQueryResult executeQuery(String selectField,
                               BrokerCriteria criteria,
                               BrokerSorting sorting,
                               BrokerResultFilter resultFilter)
                        throws com.tridion.broker.StorageException

This executes the actual broker query based on the given criteria, sorting and filter. The query will be generated and executed.

Parameters:

selectField - The default query field to select

criteria - The criteria to use for the broker query

sorting - The sort conditions to apply

resultFilter - The filter to apply to the end results

Returns:

The QueryResult, containing the item hits and found entities

Throws:

com.tridion.broker.StorageException - If unable to execute the broker query

executeQuery

BrokerQueryResult executeQuery(BrokerQueryConstructor queryConstructor,
                               BrokerResultFilter resultFilter)
                        throws com.tridion.broker.StorageException

This executes the actual broker query based on the constructed query and resultFilter.

Parameters:

queryConstructor - The constructed Query

resultFilter - The filter to apply to the end results

Returns:

The QueryResult, containing the item hits and found entities

Throws:

com.tridion.broker.StorageException - If unable to execute the broker query

generateQuery

BrokerQueryConstructor generateQuery(String selectField,
                                     BrokerCriteria criteria,
                                     BrokerSorting sorting)
                              throws com.tridion.broker.StorageException

This generates the main broker query needed to execute the JPQL query. It generates the main query based on the selected field, criteria and sorting.

Parameters:

selectField - The selected field

criteria - The criteria to use for the broker query

sorting - The sorting to apply to the query results

Returns:

The constructed broker query

Throws:

com.tridion.broker.StorageException - If unable to generate a broker query

getStorageId

String getStorageId()

Returns the storageId that the queryService will query.

Returns:

The storageId