org.alfresco.repo.search

Interface CannedQueryDef

All Known Implementing Classes:

CannedQueryDefImpl

public interface CannedQueryDef

The definition of a canned query

Author:

andyh

Method Summary

Modifier and Type	Method and Description
String	getLanguage() Get the language in which the query is defined.
NamespacePrefixResolver	getNamespacePrefixResolver() Return the mechanism that this query definition uses to map namespace prefixes to URIs.
QName	getQname() Get the unique name for the query
String	getQuery() Get the query string.
Collection<QueryParameterDefinition>	getQueryParameterDefs() Get the definitions for any query parameters.
Map<QName,QueryParameterDefinition>	getQueryParameterMap() Get a map to look up definitions by Qname

Method Detail

getQname

QName getQname()

Get the unique name for the query

Returns:

QName

getLanguage

String getLanguage()

Get the language in which the query is defined.

Returns:

String

getQueryParameterDefs

Collection<QueryParameterDefinition> getQueryParameterDefs()

Get the definitions for any query parameters.

getQuery

String getQuery()

Get the query string.

Returns:

String

getNamespacePrefixResolver

NamespacePrefixResolver getNamespacePrefixResolver()

Return the mechanism that this query definition uses to map namespace prefixes to URIs. A query may use a predefined set of prefixes for known URIs. I would be unwise to rely on the defaults.

Returns:

NamespacePrefixResolver

getQueryParameterMap

Map<QName,QueryParameterDefinition> getQueryParameterMap()

Get a map to look up definitions by Qname

Returns:

Map