%XDBC.Gateway.JDBC.CallableStatement
class %XDBC.Gateway.JDBC.CallableStatement extends %XDBC.Gateway.JDBC.PreparedStatement
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
{@link 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 {@link ResultSet} object or
multiple ResultSet objects. Multiple
ResultSet objects are handled using operations
inherited from {@link Statement}.
For maximum portability, a call's ResultSet objects and
update counts should be processed prior to getting the values of output
parameters.
@see Connection#prepareCall
@see ResultSet
Method Inventory
- GetArray()
- GetBigDecimal()
- GetBlob()
- GetBoolean()
- GetByte()
- GetBytes()
- GetCharacterStream()
- GetClob()
- GetDate()
- GetDouble()
- GetFloat()
- GetLong()
- GetNCharacterStream()
- GetNClob()
- GetNString()
- GetObject()
- GetTime()
- GetTimestamp()
- GetURL()
- SetAsciiStream()
- SetBigDecimal()
- SetBinaryStream()
- SetBlob()
- SetBoolean()
- SetByte()
- SetBytes()
- SetCharacterStream()
- SetClob()
- SetDate()
- SetDouble()
- SetFloat()
- SetInt()
- SetLong()
- SetNCharacterStream()
- SetNClob()
- SetNString()
- SetNull()
- SetObject()
- SetShort()
- SetString()
- SetTime()
- SetTimestamp()
- SetURL()
- getInt()
- getShort()
- getString()
- registerOutParameter()
- wasNull()
Methods
method GetArray(paramIdxOrName As %RawString) as %Library.DynamicArray
throws SQLException
method GetBigDecimal(paramIdxOrName As %RawString) as %Decimal
throws SQLException
method GetBlob(paramIdxOrName As %RawString) as %Stream.Object
throws SQLException
method GetBoolean(paramIdxOrName As %RawString) as %Boolean
throws SQLException;
method GetByte(paramIdxOrName As %RawString) as %Integer
throws SQLException;
method GetBytes(paramIdxOrName As %RawString) as %RawString
throws SQLException
method GetCharacterStream(paramIdxOrName As %RawString) as %Stream.Object
method GetClob(paramIdxOrName As %RawString) as %Stream.Object
method GetDate(paramIdxOrName As %RawString) as %Date
throws SQLException
method GetDouble(paramIdxOrName As %RawString) as %Double
throws SQLException
method GetFloat(paramIdxOrName As %RawString) as %Float
throws SQLException;
method GetLong(paramIdxOrName As %RawString) as %Integer
throws SQLException;
method GetNCharacterStream(paramIdxOrName As %RawString) as %Stream.Object
method GetNClob(paramIdxOrName As %RawString) as %Stream.Object
method GetNString(paramIdxOrName As %RawString) as %String
method GetObject(paramIdxOrName As %RawString, mapOrType As %Library.RawString) as %Net.Remote.Object
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 {}
method GetTime(paramIdxOrName As %RawString) as %Time
throws SQLException
method GetTimestamp(paramIdxOrName As %RawString) as %TimeStamp
throws SQLException
method GetURL(paramIdxOrName As %RawString) as %Net.Remote.Object
throws SQLException
method SetAsciiStream(paramIdxOrName As %RawString, value As %Stream.Object, length As %Integer)
method SetAsciiStream(paramIdxOrName as %RawString, value As %Stream.Object) {}
method SetBigDecimal(paramIdxOrName As %RawString, value As %Decimal)
method SetBinaryStream(paramIdxOrName As %RawString, value As %Stream.Object, length As %Integer)
method SetBlob(paramIdxOrName As %RawString, value As %Stream.Object, length As %Integer)
method SetBoolean(paramIdxOrName As %RawString, value As %Boolean)
method SetByte(paramIdxOrName As %RawString, value As %SmallInt)
method SetBytes(paramIdxOrName As %RawString, value As %RawString)
method SetCharacterStream(paramIdxOrName As %RawString, value As %Stream.Object, length As %Integer)
method SetClob(paramIdxOrName As %RawString, value As %Stream.Object, length As %Integer)
method SetDate(paramIdxOrName As %RawString, value As %Date, cal As %Net.Remote.Object)
method SetDouble(paramIdxOrName As %RawString, value As %Float)
Inherited description: void setDouble(int parameterIndex, double x)
method SetFloat(paramIdxOrName As %RawString, value As %Float)
method SetInt(paramIdxOrName As %RawString, value As %Integer)
Inherited description: void setInt(int parameterIndex, int x)
method SetLong(paramIdxOrName As %RawString, value As %Integer)
method SetNCharacterStream(paramIdxOrName As %RawString, value As %Stream.Object, length As %Integer)
method SetNCharacterStream(paramIdxOrName as %RawString, value as %Stream.Object) {}
method SetNClob(paramIdxOrName As %RawString, value As %Stream.Object, length As %Integer)
method SetNClob(paramIdxOrName as %RawString, value As %Stream.Object) {}
method SetNClob(paramIdxOrName as %RawString, value as %Stream.Object) {}
method SetNString(paramIdxOrName As %RawString, value As %String)
method SetNull(paramIdxOrName As %RawString, sqlType As %Integer, typeName As %String)
throws SQLException
method SetNull(paramIdxOrName as %RawString, sqlType as %Integer) {}
method SetObject(paramIdxOrName As %RawString, value As %ObjectHandle, targetSqlType As %Integer, scale As %Integer)
method SetObject(paramIdxOrName as %RawString, value As %ObjectHandle, targetSqlType as %Integer) {}
method SetObject(paramIdxOrName as %RawString, x) {}
method SetShort(paramIdxOrName As %RawString, value As %SmallInt)
method SetString(paramIdxOrName As %RawString, value As %String)
Inherited description: void setString(int parameterIndex, String x)
method SetTime(paramIdxOrName As %RawString, value As %Time, cal As %Net.Remote.Object)
method SetTimestamp(paramIdxOrName As %RawString, value As %TimeStamp, cal As %Net.Remote.Object)
throws SQLException
method SetTimestamp(paramIdxOrName as %RawString, value As %TimeStamp) {}
method SetURL(paramIdxOrName As %RawString, value As %RawString)
throws SQLException
method SetURL(paramIdxOrName as %RawString, java.net.URL val) {}
method getInt(paramIdxOrName As %RawString) as %Integer
throws SQLException;
method getShort(paramIdxOrName As %RawString) as %SmallInt
throws SQLException;
method getString(paramIdxOrName As %RawString) as %String
throws SQLException;
method registerOutParameter(paramIdxOrName As %RawString, sqlType As %Integer, typeName As %String)
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) {}
method wasNull() as %Boolean
throws SQLException;
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnNew()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- AddBatch()
- Cancel()
- ClearBatch()
- Close()
- Execute()
- ExecuteBatch()
- ExecuteQuery()
- ExecuteUpdate()
- GetConnection()
- GetFetchSize()
- GetGeneratedKeys()
- GetMaxFieldSize()
- GetMaxRows()
- GetMetaData()
- GetMoreResults()
- GetParameterMetaData()
- GetQueryTimeout()
- GetResultSet()
- GetUpdateCount()
- IsClosed()
- SetFetchSize()
- SetMaxFieldSize()
- SetMaxRows()
- SetQueryTimeout()