1 /**
2 * This file Copyright (c) 2003-2010 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.core.search;
35
36 import javax.jcr.Node;
37 import javax.jcr.RepositoryException;
38 import javax.jcr.query.InvalidQueryException;
39
40
41 /**
42 * Date: Apr 4, 2005 Time: 11:00:02 AM
43 * @author Sameer Charles
44 */
45
46 public interface QueryManager {
47
48 /**
49 * <i>Description inherited from javax.jcr.query.QueryManager#createQuery(String, String)</i><br>
50 * Creates a new query by specifying the query <code>statement</code> itself and the <code>language</code> in
51 * which the query is stated. If the query <code>statement</code> is syntactically invalid, given the language
52 * specified, an <code>InvalidQueryException</code> is thrown. The <code>language</code> must be a string from
53 * among those returned by QueryManager.getSupportedQueryLanguages(); if it is not, then an
54 * <code>InvalidQueryException</code> is thrown.
55 * @throws InvalidQueryException if statement is invalid or language is unsupported.
56 * @throws RepositoryException if another error occurs
57 * @return A <code>Query</code> object.
58 */
59 Query createQuery(String statement, String language) throws InvalidQueryException, RepositoryException;
60
61 /**
62 * <i>Description inherited from javax.jcr.query.QueryManager#getQuery(javax.jcr.Node)</i><br>
63 * Retrieves an existing persistent query. If <code>node</code> is not a valid persisted query (that is, a node of
64 * type <code>nt:query</code>), an <code>InvalidQueryException</code> is thrown. <p/> Persistent queries are
65 * created by first using <code>QueryManager.createQuery</code> to create a <code>Query</code> object and then
66 * calling <code>Query.save</code> to persist the query to a location in the workspace.
67 * @param node a persisted query (that is, a node of type <code>nt:query</code>).
68 * @throws InvalidQueryException If <code>node</code> is not a valid persisted query (that is, a node of type
69 * <code>nt:query</code>).
70 * @throws RepositoryException if another error occurs
71 * @return a <code>Query</code> object.
72 */
73 Query getQuery(Node node) throws InvalidQueryException, RepositoryException;
74
75 /**
76 * <i>Description inherited from javax.jcr.query.QueryManager#getSupportedQueryLanguages()</i><br>
77 * Returns an array of strings representing all query languages supported by this repository. In level 1 this set
78 * must include the string represented by the constant {@link Query#XPATH}. If SQL is supported it must
79 * additionally include the string represented by the constant {@link Query#SQL}. An implementation may also
80 * support other languages as well. See {@link Query}.
81 * @return An string array.
82 * @throws RepositoryException if an error occurs.
83 */
84 String[] getSupportedQueryLanguages() throws RepositoryException;
85
86 }