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

Interface BrokerGeneratorStrategy

public interface BrokerGeneratorStrategy

This represents the strategy that all criteria, sorting elements need to provide so a broker query can be constructed.

Method Summary

Modifier and Type	Method and Description
String	getFrom(String joinId) This generates the from part of the broker query, this indicates on which entities conditions can be applied.
String	getOrder(String joinId) This generates the ordering part of the broker query, this indicates on which entities conditions can be applied.
Map<String,Object>	getParams(String joinId) This returns the parameters needed for the strategy.
String	getSelect(String joinId) This generates the select part of the broker Query.
String	getWhere(String joinId) This generates the condition part of the broker query, this indicates on which entities conditions can be applied.

Method Detail

getSelect

String getSelect(String joinId)
          throws com.tridion.broker.querying.criteria.CriteriaException

This generates the select part of the broker Query.

Parameters:

joinId - The joinId to be used that uniquely identifies the entities for the strategy

Returns:

The String that contains the select part of the broker Query

Throws:

com.tridion.broker.querying.criteria.CriteriaException - If unable to generate the select part of the broker query

getFrom

String getFrom(String joinId)
        throws com.tridion.broker.querying.criteria.CriteriaException

This generates the from part of the broker query, this indicates on which entities conditions can be applied.

Parameters:

joinId - The joinId to be used that uniquely identifies the entities for the strategy

Returns:

The String that contains the from part of the broker Query

Throws:

com.tridion.broker.querying.criteria.CriteriaException - If unable to generate the from part of the broker query

getWhere

String getWhere(String joinId)
         throws com.tridion.broker.querying.criteria.CriteriaException

This generates the condition part of the broker query, this indicates on which entities conditions can be applied.

Parameters:

joinId - The joinId to be used that uniquely identifies the entities for the strategy

Returns:

The String that contains the condition part of the broker Query

Throws:

com.tridion.broker.querying.criteria.CriteriaException - If unable to generate the condition part of the broker query

getOrder

String getOrder(String joinId)
         throws com.tridion.broker.querying.criteria.CriteriaException

This generates the ordering part of the broker query, this indicates on which entities conditions can be applied.

Parameters:

joinId - The joinId to be used that uniquely identifies the entities for the strategy

Returns:

The String that contains the ordering part of the broker Query

Throws:

com.tridion.broker.querying.criteria.CriteriaException - If unable to generate the order part of the broker query

getParams

Map<String,Object> getParams(String joinId)
                      throws com.tridion.broker.querying.criteria.CriteriaException

This returns the parameters needed for the strategy.

Returns:

The parameters for the given strategy

Throws:

com.tridion.broker.querying.criteria.CriteriaException - If unable to generate the parameters needed