oracle.toplink.queryframework
Class EJBQLCall

java.lang.Object
  |
  +--oracle.toplink.queryframework.EJBQLCall
All Implemented Interfaces:
Call, java.lang.Cloneable, java.io.Serializable

public class EJBQLCall
extends java.lang.Object
implements java.io.Serializable, Call

Purpose: Used as an abstraction of a database invocation. A call is an EJBQL string.

See Also:
Serialized Form

Constructor Summary
EJBQLCall()
          PUBLIC Create a new EJBQLCall.
EJBQLCall(java.lang.String ejbqlString)
          PUBLIC Create a new EJBQLCall with an ejbqlString
 
Method Summary
TypeMethod
 DatabaseQuery getQuery()
          Back reference to query, unfortunately required for events.
 boolean isFinished()
          Return whether all the results of the call have been returned.
 boolean isPrepared()
          Answer true if the EJBQL string has already been parsed, and the query prepared (populated)
 oracle.toplink.internal.parsing.ejbql.EJBQLParser parseEJBQLString()
          All the query mechanism related things are initialized here.
 void populateQuery(Session session)
          Populate the query using the information retrieved from parsing the EJBQL.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EJBQLCall

public EJBQLCall()
PUBLIC Create a new EJBQLCall.

EJBQLCall

public EJBQLCall(java.lang.String ejbqlString)
PUBLIC Create a new EJBQLCall with an ejbqlString
Method Detail

clone

public java.lang.Object clone()
Description copied from interface: Call
INTERNAL: Return a clone of the call.
Specified by:
clone in interface Call

getQuery

public DatabaseQuery getQuery()
Back reference to query, unfortunately required for events.

isPrepared

public boolean isPrepared()
Answer true if the EJBQL string has already been parsed, and the query prepared (populated)

isFinished

public boolean isFinished()
Return whether all the results of the call have been returned.
Specified by:
isFinished in interface Call

parseEJBQLString

public oracle.toplink.internal.parsing.ejbql.EJBQLParser parseEJBQLString()
                                                                   throws QueryException
All the query mechanism related things are initialized here. This method is called on the *clone* of the query with every execution.

populateQuery

public void populateQuery(Session session)
Populate the query using the information retrieved from parsing the EJBQL.