mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-06-16 17:55:15 +00:00
4e2300f095
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5186 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
86 lines
2.6 KiB
Java
86 lines
2.6 KiB
Java
/*
|
|
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* This program 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 General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* As a special exception to the terms and conditions of version 2.0 of
|
|
* the GPL, you may redistribute this Program in connection with Free/Libre
|
|
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
|
* FLOSS exception. You should have recieved a copy of the text describing
|
|
* the FLOSS exception, and it is also available here:
|
|
* http://www.alfresco.com/legal/licensing"
|
|
*/
|
|
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
|
|
*/
|
|
public QName getQname();
|
|
|
|
/**
|
|
* Get the language in which the query is defined.
|
|
*
|
|
* @return
|
|
*/
|
|
public String getLanguage();
|
|
|
|
/**
|
|
* Get the definitions for any query parameters.
|
|
*
|
|
* @return
|
|
*/
|
|
public Collection<QueryParameterDefinition> getQueryParameterDefs();
|
|
|
|
/**
|
|
* Get the query string.
|
|
*
|
|
* @return
|
|
*/
|
|
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
|
|
*/
|
|
public NamespacePrefixResolver getNamespacePrefixResolver();
|
|
|
|
/**
|
|
* Get a map to look up definitions by Qname
|
|
*
|
|
* @return
|
|
*/
|
|
public Map<QName, QueryParameterDefinition> getQueryParameterMap();
|
|
}
|