atg.repository

Interface ParameterSupportQueryBuilder

All Superinterfaces:

QueryBuilder

All Known Implementing Classes:

Builder

public interface ParameterSupportQueryBuilder
extends QueryBuilder

Provides support for parameter QueryExpressions. A parameter QueryExpression is one whose value can change from execution to execution. Its purpose is to alleviate the overhead of creating new constant QueryExpressions when a constant value changes. This also provides the ability to reuse entire Query objects as well, as long as the method of executing that Query provides the ability to set the parameter QueryExpressions that reside in it in a thread-safe manner.

Parameter QueryExpressions never contain any actual value, they are simply placeholders for values that will be passed in at execution time.

See Also:

QueryBuilder, QueryExpression, ParameterSupportView, Query

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from interface atg.repository.QueryBuilder

CONTAINS, ENDS_WITH, EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_CONTAINS, NOT_ENDS_WITH, NOT_EQUALS, NOT_STARTS_WITH, STARTS_WITH

Method Summary

Modifier and Type	Method and Description
QueryExpression	createParameterQueryExpression() Creates a ParameterQueryExpression with no initial value.

Methods inherited from interface atg.repository.QueryBuilder

addContextMembershipFilters, createAndQuery, createComparisonQuery, createConstantQueryExpression, createCountQueryExpression, createElementAtQueryExpression, createIdMatchingQuery, createIncludesAllQuery, createIncludesAnyQuery, createIncludesItemQuery, createIncludesQuery, createIndexOfQueryExpression, createIsNullQuery, createNotQuery, createOrQuery, createPatternMatchQuery, createPatternMatchQuery, createPropertyQueryExpression, createPropertyQueryExpression, createReferencedByQuery, createTextSearchQuery, createTextSearchQuery, createUnconstrainedQuery, getRepositoryView

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

createParameterQueryExpression

QueryExpression createParameterQueryExpression()
                                        throws RepositoryException

Creates a ParameterQueryExpression with no initial value. When inserted into a query object the index of this expression could be changed at runtime, since it could be ANDed or ORed multiple times

Returns:

a QueryExpression whose value is supplied at the time of execution

Throws:

RepositoryException - if an expression cannot be made using this QueryBuilder