Call (EclipseLink 3.0.3, API Reference)

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

org.eclipse.persistence.internal.databaseaccess.DatabaseCall, org.eclipse.persistence.internal.databaseaccess.DatasourceCall, EISInteraction, IndexedInteraction, JPQLCall, MappedInteraction, PLSQLStoredFunctionCall, PLSQLStoredProcedureCall, QueryStringInteraction, SQLCall, StoredFunctionCall, StoredProcedureCall, XMLInteraction, XQueryInteraction
```
public interface Call
extends Cloneable, Serializable
```
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.

See Also:

DatabaseQuery

Author:

Big Country

Since:

TOPLink/Java 3.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`org.eclipse.persistence.internal.queries.DatabaseQueryMechanism`	`buildNewQueryMechanism(DatabaseQuery query)`	INTERNAL: Return the appropriate mechanism, with the call set as necessary.
`org.eclipse.persistence.internal.queries.DatabaseQueryMechanism`	`buildQueryMechanism(DatabaseQuery query, org.eclipse.persistence.internal.queries.DatabaseQueryMechanism mechanism)`	INTERNAL: Return the appropriate mechanism, with the call added as necessary.
`Object`	`clone()`	INTERNAL: Return a clone of the call.
`String`	`getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)`	INTERNAL: Return a string appropriate for the session log.
`boolean`	`isFinished()`	INTERNAL: Return whether the call is finished returning all of its results (e.g.
`boolean`	`isNothingReturned()`	The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.
`boolean`	`isOneRowReturned()`	The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.

- Method Detail
  - buildNewQueryMechanism
```
org.eclipse.persistence.internal.queries.DatabaseQueryMechanism buildNewQueryMechanism(DatabaseQuery query)
```
    INTERNAL: Return the appropriate mechanism, with the call set as necessary.
  - buildQueryMechanism
```
org.eclipse.persistence.internal.queries.DatabaseQueryMechanism buildQueryMechanism(DatabaseQuery query,
                                                                                    org.eclipse.persistence.internal.queries.DatabaseQueryMechanism mechanism)
```
    INTERNAL: Return the appropriate mechanism, with the call added as necessary.
  - clone
```
Object clone()
```
    INTERNAL: Return a clone of the call.
  - getLogString
```
String getLogString(org.eclipse.persistence.internal.databaseaccess.Accessor accessor)
```
    INTERNAL: Return a string appropriate for the session log.
  - isFinished
```
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).
  - isNothingReturned
```
boolean isNothingReturned()
```
    The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.
  - isOneRowReturned
```
boolean isOneRowReturned()
```
    The return type is one of, NoReturn, ReturnOneRow or ReturnManyRows.