Top Description Methods
org.eclipse.persistence.queries

public Interface Call

extends Cloneable, Serializable
Known Direct Subinterfaces
org.eclipse.persistence.internal.databaseaccess.QueryStringCall
Known Direct Implementers
org.eclipse.persistence.queries.JPQLCall, org.eclipse.persistence.internal.databaseaccess.DatasourceCall
Imports
java.io.Serializable, org.eclipse.persistence.internal.databaseaccess.Accessor, org.eclipse.persistence.internal.queries.*
Call defines the interface used primarily by EclipseLink 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.
Author
Big Country
Since
TOPLink/Java 3.0
See Also
DatabaseQuery

Method Summary

Modifier and TypeMethod and Description
public DatabaseQueryMechanism
buildNewQueryMechanism(DatabaseQuery query)

INTERNAL: Return the appropriate mechanism, with the call set as necessary.

public DatabaseQueryMechanism
buildQueryMechanism(DatabaseQuery query, DatabaseQueryMechanism mechanism)

INTERNAL: Return the appropriate mechanism, with the call added as necessary.

public Object
clone()

INTERNAL: Return a clone of the call.

public String
getLogString(Accessor accessor)

INTERNAL: Return a string appropriate for the session log.

public boolean
isFinished()

INTERNAL: Return whether the call is finished returning all of its results (e.g. a call that returns a cursor will answer false).

public boolean
isNothingReturned()

The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.

public boolean
isOneRowReturned()

The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.

Method Detail

buildNewQueryMechanismback to summary
public DatabaseQueryMechanism buildNewQueryMechanism(DatabaseQuery query)

INTERNAL: Return the appropriate mechanism, with the call set as necessary.

buildQueryMechanismback to summary
public DatabaseQueryMechanism buildQueryMechanism(DatabaseQuery query, DatabaseQueryMechanism mechanism)

INTERNAL: Return the appropriate mechanism, with the call added as necessary.

cloneback to summary
public Object clone()

INTERNAL: Return a clone of the call.

getLogStringback to summary
public String getLogString(Accessor accessor)

INTERNAL: Return a string appropriate for the session log.

isFinishedback to summary
public boolean isFinished()

INTERNAL: Return whether the call is finished returning all of its results (e.g. a call that returns a cursor will answer false).

isNothingReturnedback to summary
public boolean isNothingReturned()

The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.

isOneRowReturnedback to summary
public boolean isOneRowReturned()

The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.