oracle.toplink.essentials.queryframework.Call Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2007, Oracle. All rights reserved.
package oracle.toplink.essentials.queryframework;
import java.io.Serializable;
import oracle.toplink.essentials.internal.databaseaccess.Accessor;
import oracle.toplink.essentials.internal.queryframework.*;
/**
* Call defines the interface used primarily by TopLink queries
* and query mechanisms to perform the necessary actions
* (read, insert, update, delete) on the data store.
* A Call can collaborate with an Accessor to perform its
* responsibilities. The only explicit requirement of a Call is that
* it be able to supply the appropriate query mechanism for
* performing its duties. Otherwise, the Call is pretty much
* unrestricted as to how it should perform its responsibilities.
*
* @see DatabaseQuery
*
* @author Big Country
* @since TOPLink/Java 3.0
*/
public interface Call extends Cloneable, Serializable {
/**
* INTERNAL:
* Return the appropriate mechanism,
* with the call set as necessary.
*/
DatabaseQueryMechanism buildNewQueryMechanism(DatabaseQuery query);
/**
* INTERNAL:
* Return the appropriate mechanism,
* with the call added as necessary.
*/
DatabaseQueryMechanism buildQueryMechanism(DatabaseQuery query, DatabaseQueryMechanism mechanism);
/**
* INTERNAL:
* Return a clone of the call.
*/
Object clone();
/**
* INTERNAL:
* Return a string appropriate for the session log.
*/
String getLogString(Accessor accessor);
/**
* INTERNAL:
* Return whether the call is finished returning
* all of its results (e.g. a call that returns a cursor
* will answer false).
*/
boolean isFinished();
}