com.simba.dsi.ext.aetree
Class AEProcedure

java.lang.Object
  extended by com.simba.dsi.CppClassWrapper
      extended by com.simba.dsi.ext.aetree.AENode
          extended by com.simba.dsi.ext.aetree.AEQueryOperation
              extended by com.simba.dsi.ext.aetree.AERelationalExpr
                  extended by com.simba.dsi.ext.aetree.AEProcedure

public class AEProcedure
extends AERelationalExpr

A class that models a Procedure.


Constructor Summary
AEProcedure(long objRef, AEValueList arguments, boolean hasRetVal)
          Constructor.
 
Method Summary
 AEValueList getArguments()
          Retrieves the argument list.
 boolean hasReturnValue()
          Returns whether this object has a procedure call return value.
 
Methods inherited from class com.simba.dsi.ext.aetree.AERelationalExpr
isNamed
 
Methods inherited from class com.simba.dsi.ext.aetree.AEQueryOperation
getColumn, getColumnCount
 
Methods inherited from class com.simba.dsi.ext.aetree.AENode
getChild, getChildCount, getNodeType
 
Methods inherited from class com.simba.dsi.CppClassWrapper
getObjRef
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AEProcedure

public AEProcedure(long objRef,
                   AEValueList arguments,
                   boolean hasRetVal)
Constructor.

The list of valid stored procedure calls is not known until the catalog function SQLProcedures is called. If there is a procedure call return value, then all parameters must be bound by calling SQLBindParameter prior to calling SQLPrepare.

A procedure call return value has the syntax "? =". A dynamic parameter followed by an equals sign is specified on the left hand side before calling the procedure as in the following example: {? = call Procedure}.

If arguments is not NULL, then SetArguments() must be called immediately after construction of an AEProcedure.

Note: An Argument List is optional for an AEProcedure.

Parameters:
objRef - The corresponding C++ object reference.
arguments - The Argument List. NULL if there are no arguments.
hasRetVal - True if there is a procedure call return value; false otherwise.
Method Detail

getArguments

public AEValueList getArguments()
Retrieves the argument list.

Returns:
The argument list.

hasReturnValue

public boolean hasReturnValue()
Returns whether this object has a procedure call return value.

Returns:
True if this object has a procedure return value; false otherwise.


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.