CallableStatement Class Reference

The interface used to execute SQL stored procedures. More...

Inheritance diagram for CallableStatement:

Collaboration diagram for CallableStatement:

Public Member Functions
_.Library.DynamicArray	GetArray (_.Library.RawString paramIdxOrName)
	throws SQLException
_.Library.Decimal	GetBigDecimal (_.Library.RawString paramIdxOrName)
	throws SQLException
_.Stream.Object	GetBlob (_.Library.RawString paramIdxOrName)
	throws SQLException
_.Library.Boolean	GetBoolean (_.Library.RawString paramIdxOrName)
	throws SQLException;
_.Library.Integer	GetByte (_.Library.RawString paramIdxOrName)
	throws SQLException;
_.Library.RawString	GetBytes (_.Library.RawString paramIdxOrName)
	throws SQLException
_.Library.Date	GetDate (_.Library.RawString paramIdxOrName)
	throws SQLException
_.Library.Double	GetDouble (_.Library.RawString paramIdxOrName)
	throws SQLException
_.Library.Float	GetFloat (_.Library.RawString paramIdxOrName)
	throws SQLException;
_.Library.Integer	GetLong (_.Library.RawString paramIdxOrName)
	throws SQLException;
_.Net.Remote.Object	GetObject (_.Library.RawString paramIdxOrName, _.Library.RawString mapOrType)
	throws SQLException More...
_.Library.Time	GetTime (_.Library.RawString paramIdxOrName)
	throws SQLException
_.Library.TimeStamp	GetTimestamp (_.Library.RawString paramIdxOrName)
	throws SQLException
_.Net.Remote.Object	GetURL (_.Library.RawString paramIdxOrName)
	throws SQLException
	SetAsciiStream (_.Library.RawString paramIdxOrName, _.Stream.Object value, _.Library.Integer length)
	method SetAsciiStream(paramIdxOrName as RawString, value As Stream.Object) {}
	SetDouble (_.Library.RawString paramIdxOrName, _.Library.Float value)
	void setDouble(int parameterIndex, double x)
	SetInt (_.Library.RawString paramIdxOrName, _.Library.Integer value)
	void setInt(int parameterIndex, int x)
	SetNCharacterStream (_.Library.RawString paramIdxOrName, _.Stream.Object value, _.Library.Integer length)
	method SetNCharacterStream(paramIdxOrName as RawString, value as Stream.Object) {}
	SetNClob (_.Library.RawString paramIdxOrName, _.Stream.Object value, _.Library.Integer length)
	method SetNClob(paramIdxOrName as RawString, value As Stream.Object) {} More...
	SetNull (_.Library.RawString paramIdxOrName, _.Library.Integer sqlType, _.Library.String typeName)
	throws SQLException More...
	SetObject (_.Library.RawString paramIdxOrName, _.Library.ObjectHandle value, _.Library.Integer targetSqlType, _.Library.Integer scale)
	method SetObject(paramIdxOrName as RawString, value As ObjectHandle, targetSqlType as Integer) {} More...
	SetString (_.Library.RawString paramIdxOrName, _.Library.String value)
	void setString(int parameterIndex, String x)
	SetTimestamp (_.Library.RawString paramIdxOrName, _.Library.TimeStamp value, _.Net.Remote.Object cal)
	throws SQLException More...
	SetURL (_.Library.RawString paramIdxOrName, _.Library.RawString value)
	throws SQLException More...
_.Library.Integer	getInt (_.Library.RawString paramIdxOrName)
	throws SQLException;
_.Library.SmallInt	getShort (_.Library.RawString paramIdxOrName)
	throws SQLException;
_.Library.String	getString (_.Library.RawString paramIdxOrName)
	throws SQLException;
	registerOutParameter (_.Library.RawString paramIdxOrName, _.Library.Integer sqlType, _.Library.String typeName)
	throws SQLException More...
_.Library.Boolean	wasNull ()
	throws SQLException;
Public Member Functions inherited from PreparedStatement
	AddBatch (_.Library.String sql)
	Sets the value of the designated parameter with the given object. More...
_.Library.Boolean	Execute (_.Library.String void)
	boolean execute()
_.XDBC.Gateway.JDBC.ResultSet	ExecuteQuery (_.Library.String void)
	Executes the prepared statement, returns a single ResultSet object. More...
_.Library.Integer	ExecuteUpdate (_.Library.String void)
	int executeUpdate()
_.SQL.StatementMetadata	GetMetaData ()
	ResultSetMetaData getMetaData()
Public Member Functions inherited from Statement
	Cancel ()
	Cancels this Statement object if both the DBMS and driver support aborting an SQL statement.
	ClearBatch ()
	Empties this Statement object's current list of SQL commands.
	Close ()
	Releases this Statement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
_.Library.Boolean	Execute (_.Library.String sql, _.Library.Integer autoGeneratedKeys)
	Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval. More...
_.Library.ListOfDataTypes	ExecuteBatch ()
	Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.
_.Library.Integer	ExecuteUpdate (_.Library.String sql, _.Library.Integer autoGeneratedKeys)
	Executes the given SQL statement, which may be an INSERT, UPDATE, or DELETE statement or an SQL statement that returns nothing, such as an SQL DDL statement. More...
_.XDBC.Gateway.JDBC.Connection	GetConnection ()
	Retrieves the Connection object that produced this Statement object.
_.Library.Integer	GetFetchSize ()
	Retrieves the number of result set rows that is the default fetch size for ResultSet objects generated from this Statement object.
_.XDBC.Gateway.JDBC.ResultSet	GetGeneratedKeys ()
	Retrieves any auto-generated keys created as a result of executing this Statement object.
_.Library.Integer	GetMaxFieldSize ()
	Retrieves the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object.
_.Library.Integer	GetMaxRows ()
	Retrieves the maximum number of rows that a ResultSet object produced by this Statement object can contain.
_.Library.Boolean	GetMoreResults (_.Library.Integer option)
	Moves to this Statement object's next result, returns true if it is a ResultSet object, and implicitly closes any current ResultSet object(s) obtained with the method getResultSet.
_.Library.Integer	GetQueryTimeout ()
	Retrieves the number of seconds the driver will wait for a Statement object to execute.
_.XDBC.Gateway.JDBC.ResultSet	GetResultSet ()
	Retrieves the current result as a ResultSet object.
_.Library.Integer	GetUpdateCount ()
	Retrieves the current result as an update count; if the result is a ResultSet object or there are no more results, -1 is returned.
_.Library.Boolean	IsClosed ()
	Retrieves whether this Statement object has been closed.
	SetFetchSize (_.Library.Integer rows)
	Gives the driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet objects genrated by this Statement.
	SetMaxFieldSize (_.Library.Integer max)
	Sets the limit for the maximum number of bytes that can be returned for character and binary column values in a ResultSet object produced by this Statement object.
	SetMaxRows (_.Library.Integer max)
	Sets the limit for the maximum number of rows that any ResultSet object generated by this Statement object can contain to the given number.
	SetQueryTimeout (_.Library.Integer seconds)
	Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.
Public Member Functions inherited from Statement
_.Library.Boolean	GetMoreResults ()
	Moves to this Statement object's next result, returns true if it is a ResultSet object, and implicitly closes any current ResultSet object(s) obtained with the method getResultSet.
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Additional Inherited Members
Public Attributes inherited from Statement
	connection
	More...
	statement
	More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

The interface used to execute SQL stored procedures.

The JDBC API provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output or both. Parameters are referred to sequentially, by number, with the first parameter being 1.

      {?= call <procedure-name>[(<arg1>,<arg2>, ...)]}
      {call <procedure-name>[(<arg1>,<arg2>, ...)]}
    

IN parameter values are set using the set methods inherited from PreparedStatement. The type of all OUT parameters must be registered prior to executing the stored procedure; their values are retrieved after execution via the get methods provided here.

A CallableStatement can return one ResultSet object or multiple ResultSet objects. Multiple ResultSet objects are handled using operations inherited from Statement.

For maximum portability, a call's ResultSet objects and update counts should be processed prior to getting the values of output parameters.

See also

Connection::prepareCall

ResultSet

Member Function Documentation

GetObject()

_.Net.Remote.Object GetObject	(	_.Library.RawString	paramIdxOrName,
		_.Library.RawString	mapOrType
	)

throws SQLException

method GetObject(paramIdxOrName as RawString, map as Library.DynamicObject) as Net.Remote.Object {} method GetObject(paramIndex as RawString, type as String) as Net.Remote.Object {}

SetNClob()

SetNClob	(	_.Library.RawString	paramIdxOrName,
		_.Stream.Object	value,
		_.Library.Integer	length
	)

method SetNClob(paramIdxOrName as RawString, value As Stream.Object) {}

method SetNClob(paramIdxOrName as RawString, value as Stream.Object) {}

Reimplemented from PreparedStatement.

SetNull()

SetNull	(	_.Library.RawString	paramIdxOrName,
		_.Library.Integer	sqlType,
		_.Library.String	typeName
	)

throws SQLException

method SetNull(paramIdxOrName as RawString, sqlType as Integer) {}

Reimplemented from PreparedStatement.

SetObject()

SetObject	(	_.Library.RawString	paramIdxOrName,
		_.Library.ObjectHandle	value,
		_.Library.Integer	targetSqlType,
		_.Library.Integer	scale
	)

method SetObject(paramIdxOrName as RawString, value As ObjectHandle, targetSqlType as Integer) {}

method SetObject(paramIdxOrName as RawString, x) {}

Reimplemented from PreparedStatement.

SetTimestamp()

SetTimestamp	(	_.Library.RawString	paramIdxOrName,
		_.Library.TimeStamp	value,
		_.Net.Remote.Object	cal
	)

throws SQLException

method SetTimestamp(paramIdxOrName as RawString, value As TimeStamp) {}

Reimplemented from PreparedStatement.

SetURL()

SetURL	(	_.Library.RawString	paramIdxOrName,
		_.Library.RawString	value
	)

throws SQLException

method SetURL(paramIdxOrName as RawString, java.net.URL val) {}

Reimplemented from PreparedStatement.

registerOutParameter()

registerOutParameter	(	_.Library.RawString	paramIdxOrName,
		_.Library.Integer	sqlType,
		_.Library.String	typeName
	)

throws SQLException

method registerOutParameter(paramIdxOrName as RawString, sqlType as Integer) method registerOutParameter(paramIdxOrName as RawString, sqlType as Integer, scale as Integer) method registerOutParameter (paramIdxOrName as RawString, sqlType as Integer, String typeName) throws SQLException; method registerOutParameter(paramIndex as RawString, sqlType as Integer) method registerOutParameter(paramIndex as RawString, sqlType as Integer, scale as Integer) {}