/**
* Redistribution and use of this software and associated documentation
* ("Software"), with or without modification, are permitted provided
* that the following conditions are met:
*
* 1. Redistributions of source code must retain copyright
* statements and notices. Redistributions must also contain a
* copy of this document.
*
* 2. Redistributions in binary form must reproduce the
* above copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. The name "Exolab" must not be used to endorse or promote
* products derived from this Software without prior written
* permission of Intalio, Inc. For written permission,
* please contact info@exolab.org.
*
* 4. Products derived from this Software may not be called "Exolab"
* nor may "Exolab" appear in their names without prior written
* permission of Intalio, Inc. Exolab is a registered
* trademark of Intalio, Inc.
*
* 5. Due credit should be given to the Exolab Project
* (http://www.exolab.org/).
*
* THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Copyright 1999 (C) Intalio, Inc. All Rights Reserved.
*
* $Id$
*/
package org.exolab.castor.jdo;
import org.exolab.castor.mapping.AccessMode;
/**
* A query object. Obtained from the database and used to construct and
* execute a query on that database. All query operations are bound to
* the database transaction. Closing the database or the transaction will
* effectively close the query.
* <p>
* If the query specified parameters these parameters must be set
* (bound) before executing the query. Execution of the query will
* result in an enumeration of all the objects found by the query.
* The query can be re-executed by binding new parameters and calling
* the {@link #execute()} method a second time. A query can be
* re-execute while objects are still retrieved from a previous
* execution.
*
* @author <a href="arkin@intalio.com">Assaf Arkin</a>
* @version $Revision$ $Date: 2006-03-16 16:04:24 -0700 (Thu, 16 Mar 2006) $
* @see OQLQuery
* @see Database#getQuery
*/
public interface Query {
/**
* Bind a parameter value to the query. Parameters are set in the
* order in which they appear in the query and must match in number
* and type of each parameter.
*
* @param value The parameter value
* @throws IllegalArgumentException The parameter is not of the
* expected type, or more parameters were supplied that the
* query specified
*/
void bind(Object value) throws IllegalArgumentException;
/**
* Bind a parameter value to the query. Parameters are set in the
* order in which they appear in the query and must match in number
* and type of each parameter.
*
* @param value The parameter value
* @throws IllegalArgumentException The parameter is not of the
* expected type, or more parameters were supplied that the
* query specified
*/
void bind(boolean value) throws IllegalArgumentException;
/**
* Bind a parameter value to the query. Parameters are set in the
* order in which they appear in the query and must match in number
* and type of each parameter.
*
* @param value The parameter value
* @throws IllegalArgumentException The parameter is not of the
* expected type, or more parameters were supplied that the
* query specified
*/
void bind(short value) throws IllegalArgumentException;
/**
* Bind a parameter value to the query. Parameters are set in the
* order in which they appear in the query and must match in number
* and type of each parameter.
*
* @param value The parameter value
* @throws IllegalArgumentException The parameter is not of the
* expected type, or more parameters were supplied that the
* query specified
*/
void bind(int value) throws IllegalArgumentException;
/**
* Bind a parameter value to the query. Parameters are set in the
* order in which they appear in the query and must match in number
* and type of each parameter.
*
* @param value The parameter value
* @throws IllegalArgumentException The parameter is not of the
* expected type, or more parameters were supplied that the
* query specified
*/
void bind(long value) throws IllegalArgumentException;
/**
* Bind a parameter value to the query. Parameters are set in the
* order in which they appear in the query and must match in number
* and type of each parameter.
*
* @param value The parameter value
* @throws IllegalArgumentException The parameter is not of the
* expected type, or more parameters were supplied that the
* query specified
*/
void bind(float value) throws IllegalArgumentException;
/**
* Bind a parameter value to the query. Parameters are set in the
* order in which they appear in the query and must match in number
* and type of each parameter.
*
* @param value The parameter value
* @throws IllegalArgumentException The parameter is not of the
* expected type, or more parameters were supplied that the
* query specified
*/
void bind(double value) throws IllegalArgumentException;
/**
* Execute the query. The query is executed returning an enumeration
* of all the objects found. If no objects were found, the
* enumeration will be empty.
* <p>
* After execution the parameter list is reset. New parameters can
* be bound and the query re-executed.
*
* @return Query results (zero or more objects)
* @throws QueryException The query expression cannot be processed,
* or the query parameters are invalid
* @throws TransactionNotInProgressException Method called while
* transaction is not in progress
* @throws PersistenceException An error reported by the
* persistence engine
*/
QueryResults execute() throws PersistenceException;
/**
* This is used for cursor support.
* <b>Experimental</b>
*/
QueryResults execute(final boolean scrollable) throws PersistenceException;
/**
* Execute the query. The query is executed returning an enumeration
* of all the objects found. If no objects were found, the
* enumeration will be empty.
* <p>
* After execution the parameter list is reset. New parameters can
* be bound and the query re-executed.
*
* @param accessMode The access mode
* @return Query results (zero or more objects)
* @throws QueryException The query expression cannot be processed,
* or the query parameters are invalid
* @throws TransactionNotInProgressException Method called while
* transaction is not in progress
* @throws PersistenceException An error reported by the
* persistence engine
*/
QueryResults execute(final AccessMode accessMode) throws PersistenceException;
/**
* This is used for cursor support.
* <b>Experimental</b>
*/
QueryResults execute(final AccessMode accessMode, final boolean scrollable)
throws PersistenceException;
/**
* Close the query and release all resources held by the query.
*/
void close();
}