atg.repository
Interface ParameterSupportView

All Superinterfaces:

RepositoryView

public interface ParameterSupportView
extends RepositoryView

This interface provides one variation of executeQuery(..) for every existing variation in atg.repository.RepositoryView with the addition of an Object[] argument representing the values of any parameter QueryExpression objects present in the provided Query argument. In all cases, the first value in the Object[] corresponds to the first parameter present in the Query, the second value in the array corresponds to the second parameter in the Query, and so on. This behavior should not change from implementation to implementation.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

int	executeCountQuery(Query pQuery, java.lang.Object[] pParameterValues) Executes the given query and returns the number of items found that satisfy it.
RepositoryItem[]	executeQuery(Query pQuery, int pStartingIndex, int pEndingIndex, java.lang.Object[] pParameterValues) Executes the given query and returns an array of matching RepositoryItems, which are contained within a total potential result set.
RepositoryItem[]	executeQuery(Query pQuery, int pStartingIndex, int pEndingIndex, SortDirectives pSortDirectives, java.lang.Object[] pParameterValues) Executes the given query and returns an array of matching RepositoryItems, which are contained within a total potential result set.
RepositoryItem[]	executeQuery(Query pQuery, int pStartingIndex, java.lang.Object[] pParameterValues) Executes the given query and returns an array of matching RepositoryItems, beginning at the starting index element.
RepositoryItem[]	executeQuery(Query pQuery, int pStartingIndex, SortDirectives pSortDirectives, java.lang.Object[] pParameterValues) Executes the given query and returns an array of matching RepositoryItems, beginning at the starting index element.
RepositoryItem[]	executeQuery(Query pQuery, java.lang.Object[] pParameterValues) Executes the given query and returns an array of the matching RepositoryItems (not ids)
RepositoryItem[]	executeQuery(Query pQuery, QueryOptions pQueryOptions, java.lang.Object[] pParameterValues) Executes the given query and returns an array of the matching RepositoryItems (not ids)
RepositoryItem[]	executeQuery(Query pQuery, SortDirectives pSortDirectives, java.lang.Object[] pParameterValues) Executes the given query and returns an array of the matching RepositoryItems (not ids)

Methods inherited from interface atg.repository.RepositoryView

executeCountQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getItemDescriptor, getQueryBuilder, getViewName

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

executeQuery

RepositoryItem[] executeQuery(Query pQuery,
                              java.lang.Object[] pParameterValues)
                              throws RepositoryException

Executes the given query and returns an array of the matching RepositoryItems (not ids)

Parameters:

pQuery - the query to execute

pParameterValues - values of any parameter expressions that are in the given query. Each expression is replaced in the order that it is encountered with the corresponding parameter value e.g. the first parameter is replaced with pParameterValues[0], the second parameter is replaced with pParameterValues[1], etc.

Returns:

an array of RepositoryItems that satisfy the Query or null if no items could be found to match the query or if the RepositoryView does not support query operations

Throws:

RepositoryException - if there is an error while performing the query operation, or if the pParameterValues argument is faulty in some way. The manner in which pParameterValues is considered illegal is dependent upon the implementation, but common cases should include situations where the number of elements in the array don't match up with the number of parameter QueryExpressions in the Query.

executeQuery

RepositoryItem[] executeQuery(Query pQuery,
                              SortDirectives pSortDirectives,
                              java.lang.Object[] pParameterValues)
                              throws RepositoryException

Executes the given query and returns an array of the matching RepositoryItems (not ids)

Parameters:

pQuery - the query to execute

pSortDirectives - the directives to sort the result set with

pParameterValues - values of any parameter expressions that are in the given query. Each expression is replaced in the order that it is encountered with the corresponding parameter value e.g. the first parameter is replaced with pParameterValues[0], the second parameter is replaced with pParameterValues[1], etc.

Returns:

an array of RepositoryItems that satisfy the Query or null if no items could be found to match the query or if the RepositoryView does not support query operations

Throws:

RepositoryException - if there is an error while performing the query operation, or if the pParameterValues argument is faulty in some way. The manner in which pParameterValues is considered illegal is dependent upon the implementation, but common cases should include situations where the number of elements in the array don't match up with the number of parameter QueryExpressions in the Query.

executeQuery

RepositoryItem[] executeQuery(Query pQuery,
                              int pStartingIndex,
                              java.lang.Object[] pParameterValues)
                              throws RepositoryException

Executes the given query and returns an array of matching RepositoryItems, beginning at the starting index element.

Parameters:

pQuery - the query to execute

pStartingIndex - the beginning index, inclusive

pParameterValues - values of any parameter expressions that are in the given query. Each expression is replaced in the order that it is encountered with the corresponding parameter value e.g. the first parameter is replaced with pParameterValues[0], the second parameter is replaced with pParameterValues[1], etc.

Returns:

an array of RepositoryItems that satisfy the Query or null if no items could be found to match the query or if the RepositoryView does not support query operations

Throws:

RepositoryException - if there is an error while performing the query operation, or if the pParameterValues argument is faulty in some way. The manner in which pParameterValues is considered illegal is dependent upon the implementation, but common cases should include situations where the number of elements in the array don't match up with the number of parameter QueryExpressions in the Query.

executeQuery

RepositoryItem[] executeQuery(Query pQuery,
                              int pStartingIndex,
                              SortDirectives pSortDirectives,
                              java.lang.Object[] pParameterValues)
                              throws RepositoryException

Executes the given query and returns an array of matching RepositoryItems, beginning at the starting index element.

Parameters:

pQuery - the query to execute

pStartingIndex - the beginning index, inclusive

pSortDirectives - the directives to sort the result set with

pParameterValues - values of any parameter expressions that are in the given query. Each expression is replaced in the order that it is encountered with the corresponding parameter value e.g. the first parameter is replaced with pParameterValues[0], the second parameter is replaced with pParameterValues[1], etc.

Returns:

an array of RepositoryItems that satisfy the Query or null if no items could be found to match the query or if the RepositoryView does not support query operations

Throws:

RepositoryException - if there is an error while performing the query operation, or if the pParameterValues argument is faulty in some way. The manner in which pParameterValues is considered illegal is dependent upon the implementation, but common cases should include situations where the number of elements in the array don't match up with the number of parameter QueryExpressions in the Query.

executeQuery

RepositoryItem[] executeQuery(Query pQuery,
                              int pStartingIndex,
                              int pEndingIndex,
                              java.lang.Object[] pParameterValues)
                              throws RepositoryException

Executes the given query and returns an array of matching RepositoryItems, which are contained within a total potential result set. For example used if one wanted to retrieve elements 50-60 from a query which could return 100 elements.

Parameters:

pQuery - the query to execute

pStartingIndex - the beginning index, inclusive

pEndingIndex - the ending index, exclusive. A value of -1 signals to query all items in the list.

pParameterValues - values of any parameter expressions that are in the given query. Each expression is replaced in the order that it is encountered with the corresponding parameter value e.g. the first parameter is replaced with pParameterValues[0], the second parameter is replaced with pParameterValues[1], etc.

Returns:

an array of RepositoryItems that satisfy the Query or null if no items could be found to match the query or if the RepositoryView does not support query operations

Throws:

RepositoryException - if there is an error while performing the query operation, or if the pParameterValues argument is faulty in some way. The manner in which pParameterValues is considered illegal is dependent upon the implementation, but common cases should include situations where the number of elements in the array don't match up with the number of parameter QueryExpressions in the Query.

executeQuery

RepositoryItem[] executeQuery(Query pQuery,
                              int pStartingIndex,
                              int pEndingIndex,
                              SortDirectives pSortDirectives,
                              java.lang.Object[] pParameterValues)
                              throws RepositoryException

Executes the given query and returns an array of matching RepositoryItems, which are contained within a total potential result set. For example used if one wanted to retrieve elements 50-60 from a query which could return 100 elements.

Parameters:

pQuery - the query to execute

pStartingIndex - the beginning index, inclusive

pEndingIndex - the ending index, exclusive.

pSortDirectives - the directives to sort the result set with

pParameterValues - values of any parameter expressions that are in the given query. Each expression is replaced in the order that it is encountered with the corresponding parameter value e.g. the first parameter is replaced with pParameterValues[0], the second parameter is replaced with pParameterValues[1], etc.

Returns:

an array of RepositoryItems that satisfy the Query or null if no items could be found to match the query or if the RepositoryView does not support query operations

Throws:

RepositoryException - if there is an error while performing the query operation, or if the pParameterValues argument is faulty in some way. The manner in which pParameterValues is considered illegal is dependent upon the implementation, but common cases should include situations where the number of elements in the array don't match up with the number of parameter QueryExpressions in the Query.

executeQuery

RepositoryItem[] executeQuery(Query pQuery,
                              QueryOptions pQueryOptions,
                              java.lang.Object[] pParameterValues)
                              throws RepositoryException

Executes the given query and returns an array of the matching RepositoryItems (not ids)

Parameters:

pQuery - the query to execute

pQueryOptions - A set of options that may modify the query

pParameterValues - values of any parameter expressions that are in the given query. Each expression is replaced in the order that it is encountered with the corresponding parameter value e.g. the first parameter is replaced with pParameterValues[0], the second parameter is replaced with pParameterValues[1], etc.

Returns:

an array of RepositoryItems that satisfy the Query or null if no items could be found to match the query or if the RepositoryView does not support query operations

Throws:

RepositoryException - if there is an error while performing the query operation, or if the pParameterValues argument is faulty in some way. The manner in which pParameterValues is considered illegal is dependent upon the implementation, but common cases should include situations where the number of elements in the array don't match up with the number of parameter QueryExpressions in the Query.

executeCountQuery

int executeCountQuery(Query pQuery,
                      java.lang.Object[] pParameterValues)
                      throws RepositoryException

Executes the given query and returns the number of items found that satisfy it.

Parameters:

pQuery - the query to execute

pParameterValues - values of any parameter expressions that are in the given query. Each expression is replaced in the order that it is encountered with the corresponding parameter value e.g. the first parameter is replaced with pParameterValues[0], the second parameter is replaced with pParameterValues[1], etc.

Returns:

the number of RepositoryItems that are returned from pQuery

Throws:

RepositoryException - if there is an error while performing the query operation, or if the pParameterValues argument is faulty in some way. The manner in which pParameterValues is considered illegal is dependent upon the implementation, but common cases should include situations where the number of elements in the array don't match up with the number of parameter QueryExpressions in the Query.