com.sdl.web.api.broker.querying

Interface BrokerQuery

public interface BrokerQuery

The Criteria provides the structure of the QueryTree, this is used by all query criteria and operators. It makes it possible to structure a QueryTree containing nested conditions.

Method Summary

Modifier and Type	Method and Description
void	addSorting(BrokerSortParameter sortParameter) Apply sorting parameter to query.
com.tridion.meta.Item[]	executeEntityQuery() Execute the Broker query.
String[]	executeQuery() Execute the Broker query.
BrokerCriteria	getCriteria() Retrieves the Criteria applied to this Query.
void	setCriteria(BrokerCriteria queryCriteria) Sets the Criteria to apply to the Query, the CriteriaBuilder can be used to build a set of Criteria.
void	setResultFilter(BrokerResultFilter filter) Sets the result filter to the Query.

Method Detail

setResultFilter

void setResultFilter(BrokerResultFilter filter)

Sets the result filter to the Query.

Parameters:

filter - The resultFilter to apply to the query.

addSorting

void addSorting(BrokerSortParameter sortParameter)

Apply sorting parameter to query.

Parameters:

sortParameter - Sorting that will be applied.

setCriteria

void setCriteria(BrokerCriteria queryCriteria)

Sets the Criteria to apply to the Query, the CriteriaBuilder can be used to build a set of Criteria.

Parameters:

queryCriteria - The criteria to apply to the Query

getCriteria

BrokerCriteria getCriteria()

Retrieves the Criteria applied to this Query.

Returns:

The Criteria of this Query, or null if no criteria are set

executeQuery

String[] executeQuery()
               throws com.tridion.broker.StorageException

Execute the Broker query.

Returns:

An array of Strings containing the found items

Throws:

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

executeEntityQuery

com.tridion.meta.Item[] executeEntityQuery()
                                    throws com.tridion.broker.StorageException

Execute the Broker query.

Returns:

An array of Model Entities containing the found items

Throws:

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