com.arsdigita.persistence
Class DataOperation

java.lang.Object
  extended bycom.arsdigita.persistence.DataOperation

public class DataOperation
extends Object

Used to allow the user to control execution of a named DML event (a data operation, in PDL).

Since:
4.5
Version:
$Id: //core-platform/dev/src/com/arsdigita/persistence/DataOperation.java#15 $
Author:
Patrick McNeill

Field Summary
static String versionId
           
 
Method Summary
 void close()
          Explicitly closes this DataOperation if it was used to execute a PL/SQL function (CallableStatement).
 void execute()
          Executes the query.
protected  void finalize()
           
 Object get(String parameterName)
          This method allows developers that are using PL/SQL as functions and procedures that return values to retrieve those valuse after calling execute()
 Object getParameter(String parameterName)
          Allows a caller to get a parameter value for a parameter that has already been set
 void setParameter(String parameterName, Object value)
          Allows a user to bind a parameter within a named query.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Method Detail

execute

public void execute()
Executes the query. If this is a "callable" event, that is the user expects results back from the event, only one operation ("do" block) can be declared. If more than that are declared, they are all executed but the results are only available for the last one.


close

public void close()
Explicitly closes this DataOperation if it was used to execute a PL/SQL function (CallableStatement). It should be called after your program is finished calling get(String parameterName)


finalize

protected void finalize()
                 throws Throwable
Throws:
Throwable

get

public Object get(String parameterName)
This method allows developers that are using PL/SQL as functions and procedures that return values to retrieve those valuse after calling execute()

Parameters:
parameterName - The name of the parameter to retrieve

setParameter

public void setParameter(String parameterName,
                         Object value)
Allows a user to bind a parameter within a named query.

Parameters:
parameterName - The name of the parameter to bind
value - The value to assign to the parameter

getParameter

public Object getParameter(String parameterName)
Allows a caller to get a parameter value for a parameter that has already been set

Parameters:
parameterName - The name of the parameter to retrieve
Returns:
This returns the object representing the value of the parameter specified by the name or "null" if the parameter value has not yet been set.

toString

public String toString()


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC