public interface NamedQueryView extends RepositoryView
This is a RepositoryView add-on that provides methods to allow the creation of Named Queries
A "Named Query" is simply an association between a String
value and an atg.repository.Query
object. The
String
is a user-defined name that can be used to
retrieve the matching Query
object from the
ExtendedRepositoryView
. How this is accomplished is up to
the implementing class. Each Named Query can optionally have a
atg.repository.QueryDescriptor
object associated with them
that contains information about the Named Query itself, such as the name,
and a pointer to the Query object
QueryDescriptor
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Modifier and Type | Method and Description |
---|---|
void |
createNamedQuery(java.lang.String pQueryName,
Query pQuery)
Creates a Named Query.
|
Query |
getNamedQuery(java.lang.String pQueryName)
Gets the Repository Query object associated with the given name.
|
java.lang.String[] |
getNamedQueryNames()
Gets the names of all the current named queries that this RepositoryView
is aware of, if any
|
atg.repository.QueryDescriptor |
getQueryDescriptor(java.lang.String pQueryName)
Gets the QueryDescriptor object associated with the given name which
contains information about the named query.
|
java.lang.String |
getQueryName(Query pQuery)
Gets the name associated with the given Query, if any
|
executeCountQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getItemDescriptor, getQueryBuilder, getViewName
static final java.lang.String CLASS_VERSION
void createNamedQuery(java.lang.String pQueryName, Query pQuery)
getNamedQuery
method can be
used to retrieve the same Repository Query with the given name.pQueryName
- the user-defined name of this query associationpQuery
- the Query object identified by pQueryName
Query getNamedQuery(java.lang.String pQueryName)
createNamedQuery
.pQueryName
- the user-defined name of the Query that should
be returnedpQueryName
, or null
if no such association has been madejava.lang.String[] getNamedQueryNames()
java.lang.String getQueryName(Query pQuery)
pQuery
- the query to get the name foratg.repository.QueryDescriptor getQueryDescriptor(java.lang.String pQueryName)
pQueryName
- the name of the named query to get the QueryDescriptor
for