mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-08 14:51:49 +00:00
88818dca9a
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@128510 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
86 lines
2.4 KiB
Java
86 lines
2.4 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Repository
|
|
* %%
|
|
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
|
* %%
|
|
* This file is part of the Alfresco software.
|
|
* If the software was purchased under a paid Alfresco license, the terms of
|
|
* the paid license agreement will prevail. Otherwise, the software is
|
|
* provided under the following open source license terms:
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
* #L%
|
|
*/
|
|
package org.alfresco.repo.search;
|
|
|
|
import java.util.Collection;
|
|
import java.util.Map;
|
|
|
|
import org.alfresco.service.cmr.search.QueryParameterDefinition;
|
|
import org.alfresco.service.namespace.NamespacePrefixResolver;
|
|
import org.alfresco.service.namespace.QName;
|
|
|
|
/**
|
|
* The definition of a canned query
|
|
*
|
|
* @author andyh
|
|
*
|
|
*/
|
|
public interface CannedQueryDef
|
|
{
|
|
/**
|
|
* Get the unique name for the query
|
|
*
|
|
* @return QName
|
|
*/
|
|
public QName getQname();
|
|
|
|
/**
|
|
* Get the language in which the query is defined.
|
|
*
|
|
* @return String
|
|
*/
|
|
public String getLanguage();
|
|
|
|
/**
|
|
* Get the definitions for any query parameters.
|
|
*
|
|
*/
|
|
public Collection<QueryParameterDefinition> getQueryParameterDefs();
|
|
|
|
/**
|
|
* Get the query string.
|
|
*
|
|
* @return String
|
|
*/
|
|
public String getQuery();
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @return NamespacePrefixResolver
|
|
*/
|
|
public NamespacePrefixResolver getNamespacePrefixResolver();
|
|
|
|
/**
|
|
* Get a map to look up definitions by Qname
|
|
*
|
|
* @return Map
|
|
*/
|
|
public Map<QName, QueryParameterDefinition> getQueryParameterMap();
|
|
}
|