org.alfresco.repo.search

Interface CannedQueryDef

All Known Implementing Classes:

CannedQueryDefImpl

public interface CannedQueryDef

The definition of a canned query

Method Summary

Methods

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

Method Detail

getQname

org.alfresco.service.namespace.QName getQname()

Get the unique name for the query

Returns:

getLanguage

java.lang.String getLanguage()

Get the language in which the query is defined.

Returns:

getQueryParameterDefs

java.util.Collection getQueryParameterDefs()

Get the definitions for any query parameters.

Returns:

getQuery

java.lang.String getQuery()

Get the query string.

Returns:

getNamespacePrefixResolver

org.alfresco.service.namespace.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:

getQueryParameterMap

java.util.Map getQueryParameterMap()

Get a map to look up definitions by Qname

Returns: