Module com.microsoft.sqlserver.jdbc

Package com.microsoft.sqlserver.jdbc

Class SQLServerCallableStatement

java.lang.Object

com.microsoft.sqlserver.jdbc.SQLServerStatement

com.microsoft.sqlserver.jdbc.SQLServerPreparedStatement

com.microsoft.sqlserver.jdbc.SQLServerCallableStatement

All Implemented Interfaces:

ISQLServerCallableStatement, ISQLServerPreparedStatement, ISQLServerStatement, Serializable, AutoCloseable, CallableStatement, PreparedStatement, Statement, Wrapper

public class SQLServerCallableStatement
extends SQLServerPreparedStatement
implements ISQLServerCallableStatement

Provides implementation of JDBC callable statements. CallableStatement allows the caller to specify the procedure name to call along with input parameter value and output parameter types. Callable statement also allows the return of a return status with the ? = call( ?, ..) JDBC syntax

The API javadoc for JDBC API methods that this class implements are not repeated here. Please see Sun's JDBC API interfaces javadoc for those details.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.microsoft.sqlserver.jdbc.SQLServerStatement

stmtColumnEncriptionSetting

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Method Summary

Modifier and Type	Method	Description
Array	getArray(int parameterIndex)
Array	getArray(String parameterName)
InputStream	getAsciiStream(int parameterIndex)	Returns the value of the designated column in the current row of this ResultSet object as a stream of ASCII characters.
InputStream	getAsciiStream(String parameterName)	Returns the value of the designated column in the current row of this ResultSet object as a stream of ASCII characters.
BigDecimal	getBigDecimal(int parameterIndex)
BigDecimal	getBigDecimal(int parameterIndex, int scale)	Deprecated.
BigDecimal	getBigDecimal(String parameterName)
BigDecimal	getBigDecimal(String parameterName, int scale)	Deprecated.
InputStream	getBinaryStream(int parameterIndex)	Returns the value of the designated column in the current row of this ResultSet object as a stream of uninterpreted bytes.
InputStream	getBinaryStream(String parameterName)	Returns the value of the designated column in the current row of this ResultSet object as a stream of uninterpreted bytes.
Blob	getBlob(int parameterIndex)
Blob	getBlob(String parameterName)
boolean	getBoolean(int index)
boolean	getBoolean(String parameterName)
byte	getByte(int index)
byte	getByte(String parameterName)
byte[]	getBytes(int index)
byte[]	getBytes(String parameterName)
Reader	getCharacterStream(int parameterIndex)
Reader	getCharacterStream(String parameterName)
Clob	getClob(int parameterIndex)
Clob	getClob(String parameterName)
Date	getDate(int index)
Date	getDate(int index, Calendar cal)
Date	getDate(String parameterName)
Date	getDate(String parameterName, Calendar cal)
Timestamp	getDateTime(int index)	Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.
Timestamp	getDateTime(int index, Calendar cal)	Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.
Timestamp	getDateTime(String parameterName)	Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.
Timestamp	getDateTime(String name, Calendar cal)	Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.
DateTimeOffset	getDateTimeOffset(int index)	Returns the DateTimeOffset value of parameter with index parameterIndex.
DateTimeOffset	getDateTimeOffset(String parameterName)	Returns the DateTimeOffset value of parameter with name parameterName.
double	getDouble(int index)
double	getDouble(String parameterName)
float	getFloat(int index)
float	getFloat(String parameterName)
int	getInt(int index)
int	getInt(String parameterName)
long	getLong(int index)
long	getLong(String parameterName)
BigDecimal	getMoney(int parameterIndex)	Returns the value of the column specified as a java.math.BigDecimal object.
BigDecimal	getMoney(String parameterName)	Returns the value of the column specified as a java.math.BigDecimal object.
Reader	getNCharacterStream(int parameterIndex)
Reader	getNCharacterStream(String parameterName)
NClob	getNClob(int parameterIndex)
NClob	getNClob(String parameterName)
String	getNString(int parameterIndex)
String	getNString(String parameterName)
Object	getObject(int index)
<T> T	getObject(int index, Class<T> type)
Object	getObject(int parameterIndex, Map<String,Class<?>> map)
Object	getObject(String parameterName)
<T> T	getObject(String parameterName, Class<T> type)
Object	getObject(String parameterName, Map<String,Class<?>> m)
Ref	getRef(int parameterIndex)
Ref	getRef(String parameterName)
RowId	getRowId(int parameterIndex)
RowId	getRowId(String parameterName)
short	getShort(int index)
short	getShort(String parameterName)
Timestamp	getSmallDateTime(int index)	Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.
Timestamp	getSmallDateTime(int index, Calendar cal)	Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.
Timestamp	getSmallDateTime(String parameterName)	Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.
Timestamp	getSmallDateTime(String name, Calendar cal)	Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.
BigDecimal	getSmallMoney(int parameterIndex)	Returns the value of the column specified as a java.math.BigDecimal object.
BigDecimal	getSmallMoney(String parameterName)	Returns the value of the column specified as a java.math.BigDecimal object.
SQLXML	getSQLXML(int parameterIndex)
SQLXML	getSQLXML(String parameterName)
String	getString(int index)
String	getString(String parameterName)
Time	getTime(int index)
Time	getTime(int index, Calendar cal)
Time	getTime(String parameterName)
Time	getTime(String parameterName, Calendar cal)
Timestamp	getTimestamp(int index)
Timestamp	getTimestamp(int index, Calendar cal)
Timestamp	getTimestamp(String parameterName)
Timestamp	getTimestamp(String name, Calendar cal)
URL	getURL(int parameterIndex)
URL	getURL(String parameterName)
void	registerOutParameter(int index, int sqlType)
void	registerOutParameter(int index, int sqlType, int scale)
void	registerOutParameter(int index, int sqlType, int precision, int scale)	Registers the parameter in ordinal position index to be of JDBC type sqlType.
void	registerOutParameter(int index, int sqlType, String typeName)
void	registerOutParameter(int parameterIndex, SQLType sqlType)
void	registerOutParameter(int parameterIndex, SQLType sqlType, int scale)
void	registerOutParameter(int parameterIndex, SQLType sqlType, int precision, int scale)	Registers the parameter in ordinal position index to be of JDBC type sqlType.
void	registerOutParameter(int parameterIndex, SQLType sqlType, String typeName)
void	registerOutParameter(String parameterName, int sqlType)
void	registerOutParameter(String parameterName, int sqlType, int scale)
void	registerOutParameter(String parameterName, int sqlType, int precision, int scale)	Registers the parameter in ordinal position index to be of JDBC type sqlType.
void	registerOutParameter(String parameterName, int sqlType, String typeName)
void	registerOutParameter(String parameterName, SQLType sqlType)
void	registerOutParameter(String parameterName, SQLType sqlType, int scale)
void	registerOutParameter(String parameterName, SQLType sqlType, int precision, int scale)	Registers the parameter in ordinal position index to be of JDBC type sqlType.
void	registerOutParameter(String parameterName, SQLType sqlType, String typeName)
void	setAsciiStream(String parameterName, InputStream value)
void	setAsciiStream(String parameterName, InputStream value, int length)
void	setAsciiStream(String parameterName, InputStream value, long length)
void	setBigDecimal(String parameterName, BigDecimal value)
void	setBigDecimal(String parameterName, BigDecimal value, int precision, int scale)	Sets the designated parameter to the given java.math.BigDecimal value.
void	setBigDecimal(String parameterName, BigDecimal value, int precision, int scale, boolean forceEncrypt)	Sets the designated parameter to the given java.math.BigDecimal value.
void	setBinaryStream(String parameterName, InputStream value)
void	setBinaryStream(String parameterName, InputStream value, int length)
void	setBinaryStream(String parameterName, InputStream value, long length)
void	setBlob(String parameterName, InputStream value)
void	setBlob(String parameterName, InputStream inputStream, long length)
void	setBlob(String parameterName, Blob inputStream)
void	setBoolean(String parameterName, boolean value)
void	setBoolean(String parameterName, boolean value, boolean forceEncrypt)	Sets the designated parameter to the given Java boolean value.
void	setByte(String parameterName, byte value)
void	setByte(String parameterName, byte value, boolean forceEncrypt)	Sets the designated parameter to the given Java byte value.
void	setBytes(String parameterName, byte[] value)
void	setBytes(String parameterName, byte[] value, boolean forceEncrypt)	Sets the designated parameter to the given Java array of bytes.
void	setCharacterStream(String parameterName, Reader reader)
void	setCharacterStream(String parameterName, Reader value, int length)
void	setCharacterStream(String parameterName, Reader reader, long length)
void	setClob(String parameterName, Reader reader)
void	setClob(String parameterName, Reader value, long length)
void	setClob(String parameterName, Clob value)
void	setDate(String parameterName, Date value)
void	setDate(String parameterName, Date value, Calendar calendar)
void	setDate(String parameterName, Date value, Calendar calendar, boolean forceEncrypt)	Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
void	setDateTime(String parameterName, Timestamp value)	Sets the designated parameter to the given java.sql.Timestamp value.
void	setDateTime(String parameterName, Timestamp value, boolean forceEncrypt)	Sets the designated parameter to the given java.sql.Timestamp value.
void	setDateTimeOffset(String parameterName, DateTimeOffset value)	Sets parameter parameterName to DateTimeOffset value.
void	setDateTimeOffset(String parameterName, DateTimeOffset value, int scale)	Sets parameter parameterName to DateTimeOffset value.
void	setDateTimeOffset(String parameterName, DateTimeOffset value, int scale, boolean forceEncrypt)	Sets parameter parameterName to DateTimeOffset value.
void	setDouble(String parameterName, double value)
void	setDouble(String parameterName, double value, boolean forceEncrypt)	Sets the designated parameter to the given Java double value.
void	setFloat(String parameterName, float value)
void	setFloat(String parameterName, float value, boolean forceEncrypt)	Sets the designated parameter to the given Java float value.
void	setInt(String parameterName, int value)
void	setInt(String parameterName, int value, boolean forceEncrypt)	Sets the designated parameter to the given Java int value.
void	setLong(String parameterName, long value)
void	setLong(String parameterName, long value, boolean forceEncrypt)	Sets the designated parameter to the given Java long value.
void	setMoney(String parameterName, BigDecimal value)	Sets the designated parameter to the given Java java.math.BigDecimal value.
void	setMoney(String parameterName, BigDecimal value, boolean forceEncrypt)	Sets the designated parameter to the given Java java.math.BigDecimal value.
void	setNCharacterStream(String parameterName, Reader value)
void	setNCharacterStream(String parameterName, Reader value, long length)
void	setNClob(String parameterName, Reader reader)
void	setNClob(String parameterName, Reader reader, long length)
void	setNClob(String parameterName, NClob value)
void	setNString(String parameterName, String value)
void	setNString(String parameterName, String value, boolean forceEncrypt)	Sets the designated parameter to the given String object.
void	setNull(String parameterName, int nType)
void	setNull(String parameterName, int nType, String sTypeName)
void	setObject(String parameterName, Object value)
void	setObject(String parameterName, Object value, int sqlType)
void	setObject(String parameterName, Object value, int sqlType, int decimals)
void	setObject(String parameterName, Object value, int sqlType, int decimals, boolean forceEncrypt)	Sets the value of the designated parameter with the given object.
void	setObject(String parameterName, Object value, int targetSqlType, Integer precision, int scale)	Sets the value of the designated parameter with the given object.
void	setObject(String parameterName, Object value, SQLType jdbcType)
void	setObject(String parameterName, Object value, SQLType jdbcType, int scale)
void	setObject(String parameterName, Object value, SQLType jdbcType, int scale, boolean forceEncrypt)	Sets the value of the designated parameter with the given object.
void	setRowId(String parameterName, RowId value)
void	setShort(String parameterName, short value)
void	setShort(String parameterName, short value, boolean forceEncrypt)	Sets the designated parameter to the given Java short value.
void	setSmallDateTime(String parameterName, Timestamp value)	Sets the designated parameter to the given java.sql.Timestamp value.
void	setSmallDateTime(String parameterName, Timestamp value, boolean forceEncrypt)	Sets the designated parameter to the given java.sql.Timestamp value.
void	setSmallMoney(String parameterName, BigDecimal value)	Sets the designated parameter to the given Java java.math.BigDecimal value.
void	setSmallMoney(String parameterName, BigDecimal value, boolean forceEncrypt)	Sets the designated parameter to the given Java java.math.BigDecimal value.
void	setSQLXML(String parameterName, SQLXML xmlObject)
void	setString(String parameterName, String value)
void	setString(String parameterName, String value, boolean forceEncrypt)	Sets the designated parameter to the given Java String value.
void	setStructured(String parameterName, String tvpName, ISQLServerDataRecord tvpDataRecord)	Populates a table valued parameter passed to a stored procedure with an ISQLServerDataRecord object.
void	setStructured(String parameterName, String tvpName, SQLServerDataTable tvpDataTable)	Populates a table valued parameter passed to a stored procedure with a data table.
void	setStructured(String parameterName, String tvpName, ResultSet tvpResultSet)	Populates a table valued parameter passed to a stored procedure with a ResultSet retrieved from another table
void	setTime(String parameterName, Time value)
void	setTime(String parameterName, Time value, int scale)	Sets the designated parameter to the given java.sql.Time value.
void	setTime(String parameterName, Time value, int scale, boolean forceEncrypt)	Sets the designated parameter to the given java.sql.Time value.
void	setTime(String parameterName, Time value, Calendar calendar)
void	setTime(String parameterName, Time value, Calendar calendar, boolean forceEncrypt)	Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
void	setTimestamp(String parameterName, Timestamp value)
void	setTimestamp(String parameterName, Timestamp value, int scale)	Sets the designated parameter to the given java.sql.Timestamp value.
void	setTimestamp(String parameterName, Timestamp value, int scale, boolean forceEncrypt)	Sets the designated parameter to the given java.sql.Timestamp value.
void	setTimestamp(String parameterName, Timestamp value, Calendar calendar)
void	setTimestamp(String parameterName, Timestamp value, Calendar calendar, boolean forceEncrypt)	Sets the designated parameter to the given java.sql.Timestamp value.
void	setUniqueIdentifier(String parameterName, String guid)	Sets the designated parameter to the given String value.
void	setUniqueIdentifier(String parameterName, String guid, boolean forceEncrypt)	Sets the designated parameter to the given String value.
void	setURL(String parameterName, URL url)
boolean	wasNull()

Methods inherited from class com.microsoft.sqlserver.jdbc.SQLServerPreparedStatement

addBatch, addBatch, clearBatch, clearParameters, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeQuery, executeQuery, executeUpdate, executeUpdate, getMetaData, getParameterMetaData, getParameterMetaData, getPreparedStatementHandle, getUseFmtOnly, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBigDecimal, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setBoolean, setByte, setByte, setBytes, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDate, setDateTime, setDateTime, setDateTimeOffset, setDateTimeOffset, setDateTimeOffset, setDouble, setDouble, setFloat, setFloat, setGeography, setGeometry, setInt, setInt, setLong, setLong, setMoney, setMoney, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setObject, setObject, setObject, setObject, setRef, setRowId, setShort, setShort, setSmallDateTime, setSmallDateTime, setSmallMoney, setSmallMoney, setSQLXML, setString, setString, setStructured, setStructured, setStructured, setTime, setTime, setTime, setTime, setTime, setTimestamp, setTimestamp, setTimestamp, setTimestamp, setTimestamp, setUnicodeStream, setUniqueIdentifier, setUniqueIdentifier, setURL, setUseFmtOnly

Methods inherited from class com.microsoft.sqlserver.jdbc.SQLServerStatement

cancel, clearWarnings, close, closeOnCompletion, execute, execute, execute, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeUpdate, executeUpdate, executeUpdate, getCancelQueryTimeout, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResponseBuffering, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getStmtColumnEncriptionSetting, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isWrapperFor, setCancelQueryTimeout, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout, setResponseBuffering, toString, unwrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microsoft.sqlserver.jdbc.ISQLServerPreparedStatement

getParameterMetaData, getPreparedStatementHandle, getUseFmtOnly, setBigDecimal, setBigDecimal, setBoolean, setByte, setBytes, setDate, setDateTime, setDateTime, setDateTimeOffset, setDateTimeOffset, setDateTimeOffset, setDouble, setFloat, setGeography, setGeometry, setInt, setLong, setMoney, setMoney, setNString, setObject, setObject, setObject, setObject, setShort, setSmallDateTime, setSmallDateTime, setSmallMoney, setSmallMoney, setString, setStructured, setStructured, setStructured, setTime, setTime, setTime, setTimestamp, setTimestamp, setTimestamp, setUniqueIdentifier, setUniqueIdentifier, setUseFmtOnly

Methods inherited from interface com.microsoft.sqlserver.jdbc.ISQLServerStatement

getCancelQueryTimeout, getResponseBuffering, setCancelQueryTimeout, setResponseBuffering

Methods inherited from interface java.sql.PreparedStatement

addBatch, clearParameters, execute, executeLargeUpdate, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isSimpleIdentifier, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Details

registerOutParameter

public void registerOutParameter(int index,
 int sqlType)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(int index,
 int sqlType,
 String typeName)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(int index,
 int sqlType,
 int scale)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(int index,
 int sqlType,
 int precision,
 int scale)
                          throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Registers the parameter in ordinal position index to be of JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

Specified by:

registerOutParameter in interface ISQLServerCallableStatement

Parameters:

index - the first column is 1, the second is 2, ...

sqlType - the JDBC type code defined by SQLType to use to register the OUT Parameter.

precision - the sum of the desired number of digits to the left and right of the decimal point. It must be greater than or equal to zero.

scale - the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

Throws:

SQLServerException - If any errors occur.

getInt

public int getInt(int index)
           throws SQLServerException

Specified by:

getInt in interface CallableStatement

Throws:

SQLServerException

getInt

public int getInt(String parameterName)
           throws SQLServerException

Specified by:

getInt in interface CallableStatement

Throws:

SQLServerException

getString

public String getString(int index)
                 throws SQLServerException

Specified by:

getString in interface CallableStatement

Throws:

SQLServerException

getString

public String getString(String parameterName)
                 throws SQLServerException

Specified by:

getString in interface CallableStatement

Throws:

SQLServerException

getNString

public final String getNString(int parameterIndex)
                        throws SQLException

Specified by:

getNString in interface CallableStatement

Throws:

SQLException

getNString

public final String getNString(String parameterName)
                        throws SQLException

Specified by:

getNString in interface CallableStatement

Throws:

SQLException

getBigDecimal

@Deprecated
public BigDecimal getBigDecimal(int parameterIndex,
 int scale)
                         throws SQLException

Deprecated.

Specified by:

getBigDecimal in interface CallableStatement

Throws:

SQLException

getBigDecimal

@Deprecated
public BigDecimal getBigDecimal(String parameterName,
 int scale)
                         throws SQLServerException

Deprecated.

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a java.sql.BigDecimal object in the Java programming language.

Specified by:

getBigDecimal in interface ISQLServerCallableStatement

Parameters:

parameterName - the label for the column

scale - the scale of the BigDecimal

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getBoolean

public boolean getBoolean(int index)
                   throws SQLServerException

Specified by:

getBoolean in interface CallableStatement

Throws:

SQLServerException

getBoolean

public boolean getBoolean(String parameterName)
                   throws SQLServerException

Specified by:

getBoolean in interface CallableStatement

Throws:

SQLServerException

getByte

public byte getByte(int index)
             throws SQLServerException

Specified by:

getByte in interface CallableStatement

Throws:

SQLServerException

getByte

public byte getByte(String parameterName)
             throws SQLServerException

Specified by:

getByte in interface CallableStatement

Throws:

SQLServerException

getBytes

public byte[] getBytes(int index)
                throws SQLServerException

Specified by:

getBytes in interface CallableStatement

Throws:

SQLServerException

getBytes

public byte[] getBytes(String parameterName)
                throws SQLServerException

Specified by:

getBytes in interface CallableStatement

Throws:

SQLServerException

getDate

public Date getDate(int index)
             throws SQLServerException

Specified by:

getDate in interface CallableStatement

Throws:

SQLServerException

getDate

public Date getDate(String parameterName)
             throws SQLServerException

Specified by:

getDate in interface CallableStatement

Throws:

SQLServerException

getDate

public Date getDate(int index,
 Calendar cal)
             throws SQLServerException

Specified by:

getDate in interface CallableStatement

Throws:

SQLServerException

getDate

public Date getDate(String parameterName,
 Calendar cal)
             throws SQLServerException

Specified by:

getDate in interface CallableStatement

Throws:

SQLServerException

getDouble

public double getDouble(int index)
                 throws SQLServerException

Specified by:

getDouble in interface CallableStatement

Throws:

SQLServerException

getDouble

public double getDouble(String parameterName)
                 throws SQLServerException

Specified by:

getDouble in interface CallableStatement

Throws:

SQLServerException

getFloat

public float getFloat(int index)
               throws SQLServerException

Specified by:

getFloat in interface CallableStatement

Throws:

SQLServerException

getFloat

public float getFloat(String parameterName)
               throws SQLServerException

Specified by:

getFloat in interface CallableStatement

Throws:

SQLServerException

getLong

public long getLong(int index)
             throws SQLServerException

Specified by:

getLong in interface CallableStatement

Throws:

SQLServerException

getLong

public long getLong(String parameterName)
             throws SQLServerException

Specified by:

getLong in interface CallableStatement

Throws:

SQLServerException

getObject

public Object getObject(int index)
                 throws SQLServerException

Specified by:

getObject in interface CallableStatement

Throws:

SQLServerException

getObject

public <T> T getObject(int index,
 Class<T> type)
                throws SQLException

Specified by:

getObject in interface CallableStatement

Throws:

SQLException

getObject

public Object getObject(String parameterName)
                 throws SQLServerException

Specified by:

getObject in interface CallableStatement

Throws:

SQLServerException

getObject

public <T> T getObject(String parameterName,
 Class<T> type)
                throws SQLException

Specified by:

getObject in interface CallableStatement

Throws:

SQLException

getShort

public short getShort(int index)
               throws SQLServerException

Specified by:

getShort in interface CallableStatement

Throws:

SQLServerException

getShort

public short getShort(String parameterName)
               throws SQLServerException

Specified by:

getShort in interface CallableStatement

Throws:

SQLServerException

getTime

public Time getTime(int index)
             throws SQLServerException

Specified by:

getTime in interface CallableStatement

Throws:

SQLServerException

getTime

public Time getTime(String parameterName)
             throws SQLServerException

Specified by:

getTime in interface CallableStatement

Throws:

SQLServerException

getTime

public Time getTime(int index,
 Calendar cal)
             throws SQLServerException

Specified by:

getTime in interface CallableStatement

Throws:

SQLServerException

getTime

public Time getTime(String parameterName,
 Calendar cal)
             throws SQLServerException

Specified by:

getTime in interface CallableStatement

Throws:

SQLServerException

getTimestamp

public Timestamp getTimestamp(int index)
                       throws SQLServerException

Specified by:

getTimestamp in interface CallableStatement

Throws:

SQLServerException

getTimestamp

public Timestamp getTimestamp(String parameterName)
                       throws SQLServerException

Specified by:

getTimestamp in interface CallableStatement

Throws:

SQLServerException

getTimestamp

public Timestamp getTimestamp(int index,
 Calendar cal)
                       throws SQLServerException

Specified by:

getTimestamp in interface CallableStatement

Throws:

SQLServerException

getTimestamp

public Timestamp getTimestamp(String name,
 Calendar cal)
                       throws SQLServerException

Specified by:

getTimestamp in interface CallableStatement

Throws:

SQLServerException

getDateTime

public Timestamp getDateTime(int index)
                      throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.

Specified by:

getDateTime in interface ISQLServerCallableStatement

Parameters:

index - the first column is 1, the second is 2, ...

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getDateTime

public Timestamp getDateTime(String parameterName)
                      throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.

Specified by:

getDateTime in interface ISQLServerCallableStatement

Parameters:

parameterName - the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getDateTime

public Timestamp getDateTime(int index,
 Calendar cal)
                      throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language. This method uses the given calendar to construct an appropriate millisecond value for the timestamp if the underlying database does not store timezone information.

Specified by:

getDateTime in interface ISQLServerCallableStatement

Parameters:

index - the first column is 1, the second is 2, ...

cal - the java.util.Calendar object to use in constructing the dateTime

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getDateTime

public Timestamp getDateTime(String name,
 Calendar cal)
                      throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language. This method uses the given calendar to construct an appropriate millisecond value for the timestamp if the underlying database does not store timezone information.

Specified by:

getDateTime in interface ISQLServerCallableStatement

Parameters:

name - the name of the column

cal - the java.util.Calendar object to use in constructing the dateTime

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getSmallDateTime

public Timestamp getSmallDateTime(int index)
                           throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.

Specified by:

getSmallDateTime in interface ISQLServerCallableStatement

Parameters:

index - the first column is 1, the second is 2, ...

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getSmallDateTime

public Timestamp getSmallDateTime(String parameterName)
                           throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.

Specified by:

getSmallDateTime in interface ISQLServerCallableStatement

Parameters:

parameterName - The name of a column.

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getSmallDateTime

public Timestamp getSmallDateTime(int index,
 Calendar cal)
                           throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.

Specified by:

getSmallDateTime in interface ISQLServerCallableStatement

Parameters:

index - the first column is 1, the second is 2, ...

cal - the java.util.Calendar object to use in constructing the smalldateTime

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getSmallDateTime

public Timestamp getSmallDateTime(String name,
 Calendar cal)
                           throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a java.sql.Timestamp object in the Java programming language.

Specified by:

getSmallDateTime in interface ISQLServerCallableStatement

Parameters:

name - The name of a column

cal - the java.util.Calendar object to use in constructing the smalldateTime

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getDateTimeOffset

public DateTimeOffset getDateTimeOffset(int index)
                                 throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the DateTimeOffset value of parameter with index parameterIndex.

Specified by:

getDateTimeOffset in interface ISQLServerCallableStatement

Parameters:

index - the first parameter is 1, the second is 2, and so on

Returns:

DateTimeOffset value if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - if parameterIndex is out of range; if a database access error occurs or this method is called on a closed CallableStatement

getDateTimeOffset

public DateTimeOffset getDateTimeOffset(String parameterName)
                                 throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the DateTimeOffset value of parameter with name parameterName.

Specified by:

getDateTimeOffset in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

Returns:

DateTimeOffset value if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

wasNull

public boolean wasNull()
                throws SQLServerException

Specified by:

wasNull in interface CallableStatement

Throws:

SQLServerException

getAsciiStream

public final InputStream getAsciiStream(int parameterIndex)
                                 throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a stream of ASCII characters. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARCHAR values. The JDBC driver will do any necessary conversion from the database format into ASCII.

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return 0 when the method InputStream.available is called whether there is data available or not.

Specified by:

getAsciiStream in interface ISQLServerCallableStatement

Parameters:

parameterIndex - the first column is 1, the second is 2, ...

Returns:

a Java input stream that delivers the database column value as a stream of one-byte ASCII characters; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set

getAsciiStream

public final InputStream getAsciiStream(String parameterName)
                                 throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a stream of ASCII characters. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARCHAR values. The JDBC driver will do any necessary conversion from the database format into ASCII.

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return 0 when the method available is called whether there is data available or not.

Specified by:

getAsciiStream in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

Returns:

a Java input stream that delivers the database column value as a stream of one-byte ASCII characters. If the value is SQL NULL, the value returned is null.

Throws:

SQLServerException - if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set

getBigDecimal

public BigDecimal getBigDecimal(int parameterIndex)
                         throws SQLServerException

Specified by:

getBigDecimal in interface CallableStatement

Throws:

SQLServerException

getBigDecimal

public BigDecimal getBigDecimal(String parameterName)
                         throws SQLServerException

Specified by:

getBigDecimal in interface CallableStatement

Throws:

SQLServerException

getMoney

public BigDecimal getMoney(int parameterIndex)
                    throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the column specified as a java.math.BigDecimal object.

Specified by:

getMoney in interface ISQLServerCallableStatement

Parameters:

parameterIndex - The zero-based ordinal of a column.

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getMoney

public BigDecimal getMoney(String parameterName)
                    throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the column specified as a java.math.BigDecimal object.

Specified by:

getMoney in interface ISQLServerCallableStatement

Parameters:

parameterName - The name of a column.

Returns:

the column value; if the value is SQL NULL, the value returned is null.

Throws:

SQLServerException - when an error occurs

getSmallMoney

public BigDecimal getSmallMoney(int parameterIndex)
                         throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the column specified as a java.math.BigDecimal object.

Specified by:

getSmallMoney in interface ISQLServerCallableStatement

Parameters:

parameterIndex - The zero-based ordinal of a column.

Returns:

the column value; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - when an error occurs

getSmallMoney

public BigDecimal getSmallMoney(String parameterName)
                         throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the column specified as a java.math.BigDecimal object.

Specified by:

getSmallMoney in interface ISQLServerCallableStatement

Parameters:

parameterName - The name of a column.

Returns:

the column value; if the value is SQL NULL, the value returned is null.

Throws:

SQLServerException - when an error occurs

getBinaryStream

public final InputStream getBinaryStream(int parameterIndex)
                                  throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a stream of uninterpreted bytes. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY values.

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return 0 when the method InputStream.available is called whether there is data available or not.

Specified by:

getBinaryStream in interface ISQLServerCallableStatement

Parameters:

parameterIndex - the first column is 1, the second is 2, ...

Returns:

a Java input stream that delivers the database column value as a stream of uninterpreted bytes; if the value is SQL NULL, the value returned is null

Throws:

SQLServerException - if the columnIndex is not valid; if a database access error occurs or this method is called on a closed result set

getBinaryStream

public final InputStream getBinaryStream(String parameterName)
                                  throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Returns the value of the designated column in the current row of this ResultSet object as a stream of uninterpreted bytes. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY values.

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a getter method implicitly closes the stream. Also, a stream may return 0 when the method available is called whether there is data available or not.

Specified by:

getBinaryStream in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

Returns:

a Java input stream that delivers the database column value as a stream of uninterpreted bytes; if the value is SQL NULL, the result is null

Throws:

SQLServerException - if the columnLabel is not valid; if a database access error occurs or this method is called on a closed result set

getBlob

public Blob getBlob(int parameterIndex)
             throws SQLServerException

Specified by:

getBlob in interface CallableStatement

Throws:

SQLServerException

getBlob

public Blob getBlob(String parameterName)
             throws SQLServerException

Specified by:

getBlob in interface CallableStatement

Throws:

SQLServerException

getCharacterStream

public final Reader getCharacterStream(int parameterIndex)
                                throws SQLServerException

Specified by:

getCharacterStream in interface CallableStatement

Throws:

SQLServerException

getCharacterStream

public final Reader getCharacterStream(String parameterName)
                                throws SQLException

Specified by:

getCharacterStream in interface CallableStatement

Throws:

SQLException

getNCharacterStream

public final Reader getNCharacterStream(int parameterIndex)
                                 throws SQLException

Specified by:

getNCharacterStream in interface CallableStatement

Throws:

SQLException

getNCharacterStream

public final Reader getNCharacterStream(String parameterName)
                                 throws SQLException

Specified by:

getNCharacterStream in interface CallableStatement

Throws:

SQLException

getClob

public Clob getClob(int parameterIndex)
             throws SQLServerException

Specified by:

getClob in interface CallableStatement

Throws:

SQLServerException

getClob

public Clob getClob(String parameterName)
             throws SQLServerException

Specified by:

getClob in interface CallableStatement

Throws:

SQLServerException

getNClob

public NClob getNClob(int parameterIndex)
               throws SQLException

Specified by:

getNClob in interface CallableStatement

Throws:

SQLException

getNClob

public NClob getNClob(String parameterName)
               throws SQLException

Specified by:

getNClob in interface CallableStatement

Throws:

SQLException

getObject

public Object getObject(int parameterIndex,
 Map<String,Class<?>> map)
                 throws SQLException

Specified by:

getObject in interface CallableStatement

Throws:

SQLException

getObject

public Object getObject(String parameterName,
 Map<String,Class<?>> m)
                 throws SQLException

Specified by:

getObject in interface CallableStatement

Throws:

SQLException

getRef

public Ref getRef(int parameterIndex)
           throws SQLException

Specified by:

getRef in interface CallableStatement

Throws:

SQLException

getRef

public Ref getRef(String parameterName)
           throws SQLException

Specified by:

getRef in interface CallableStatement

Throws:

SQLException

getArray

public Array getArray(int parameterIndex)
               throws SQLException

Specified by:

getArray in interface CallableStatement

Throws:

SQLException

getArray

public Array getArray(String parameterName)
               throws SQLException

Specified by:

getArray in interface CallableStatement

Throws:

SQLException

setTimestamp

public void setTimestamp(String parameterName,
 Timestamp value,
 Calendar calendar)
                  throws SQLServerException

Specified by:

setTimestamp in interface CallableStatement

Throws:

SQLServerException

setTimestamp

public void setTimestamp(String parameterName,
 Timestamp value,
 Calendar calendar,
 boolean forceEncrypt)
                  throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Specified by:

setTimestamp in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

calendar - a java.util.Calendar

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

CallableStatement.getTimestamp(int)

setTime

public void setTime(String parameterName,
 Time value,
 Calendar calendar)
             throws SQLServerException

Specified by:

setTime in interface CallableStatement

Throws:

SQLServerException

setTime

public void setTime(String parameterName,
 Time value,
 Calendar calendar,
 boolean forceEncrypt)
             throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Time value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIME value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the time taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Specified by:

setTime in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

calendar - the Calendar object the driver will use to construct the time

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

CallableStatement.getTime(int)

setDate

public void setDate(String parameterName,
 Date value,
 Calendar calendar)
             throws SQLServerException

Specified by:

setDate in interface CallableStatement

Throws:

SQLServerException

setDate

public void setDate(String parameterName,
 Date value,
 Calendar calendar,
 boolean forceEncrypt)
             throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Date value, using the given Calendar object. The driver uses the Calendar object to construct an SQL DATE value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the date taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Specified by:

setDate in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

calendar - the Calendar object the driver will use to construct the date

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

CallableStatement.getDate(int)

setCharacterStream

public final void setCharacterStream(String parameterName,
 Reader reader)
                              throws SQLException

Specified by:

setCharacterStream in interface CallableStatement

Throws:

SQLException

setCharacterStream

public final void setCharacterStream(String parameterName,
 Reader value,
 int length)
                              throws SQLException

Specified by:

setCharacterStream in interface CallableStatement

Throws:

SQLException

setCharacterStream

public final void setCharacterStream(String parameterName,
 Reader reader,
 long length)
                              throws SQLException

Specified by:

setCharacterStream in interface CallableStatement

Throws:

SQLException

setNCharacterStream

public final void setNCharacterStream(String parameterName,
 Reader value)
                               throws SQLException

Specified by:

setNCharacterStream in interface CallableStatement

Throws:

SQLException

setNCharacterStream

public final void setNCharacterStream(String parameterName,
 Reader value,
 long length)
                               throws SQLException

Specified by:

setNCharacterStream in interface CallableStatement

Throws:

SQLException

setClob

public final void setClob(String parameterName,
 Clob value)
                   throws SQLException

Specified by:

setClob in interface CallableStatement

Throws:

SQLException

setClob

public final void setClob(String parameterName,
 Reader reader)
                   throws SQLException

Specified by:

setClob in interface CallableStatement

Throws:

SQLException

setClob

public final void setClob(String parameterName,
 Reader value,
 long length)
                   throws SQLException

Specified by:

setClob in interface CallableStatement

Throws:

SQLException

setNClob

public final void setNClob(String parameterName,
 NClob value)
                    throws SQLException

Specified by:

setNClob in interface CallableStatement

Throws:

SQLException

setNClob

public final void setNClob(String parameterName,
 Reader reader)
                    throws SQLException

Specified by:

setNClob in interface CallableStatement

Throws:

SQLException

setNClob

public final void setNClob(String parameterName,
 Reader reader,
 long length)
                    throws SQLException

Specified by:

setNClob in interface CallableStatement

Throws:

SQLException

setNString

public final void setNString(String parameterName,
 String value)
                      throws SQLException

Specified by:

setNString in interface CallableStatement

Throws:

SQLException

setNString

public final void setNString(String parameterName,
 String value,
 boolean forceEncrypt)
                      throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given String object. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR

Specified by:

setNString in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter to be set

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement

setObject

public void setObject(String parameterName,
 Object value)
               throws SQLServerException

Specified by:

setObject in interface CallableStatement

Throws:

SQLServerException

setObject

public void setObject(String parameterName,
 Object value,
 int sqlType)
               throws SQLServerException

Specified by:

setObject in interface CallableStatement

Throws:

SQLServerException

setObject

public void setObject(String parameterName,
 Object value,
 int sqlType,
 int decimals)
               throws SQLServerException

Specified by:

setObject in interface CallableStatement

Throws:

SQLServerException

setObject

public void setObject(String parameterName,
 Object value,
 int sqlType,
 int decimals,
 boolean forceEncrypt)
               throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the value of the designated parameter with the given object.

The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, java.net.URL, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Note that this method may be used to pass database- specific abstract data types.

Specified by:

setObject in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the object containing the input parameter value

sqlType - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.

decimals - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

Types, CallableStatement.getObject(int)

setObject

public final void setObject(String parameterName,
 Object value,
 int targetSqlType,
 Integer precision,
 int scale)
                     throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the value of the designated parameter with the given object.

The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, java.net.URL, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Note that this method may be used to pass datatabase- specific abstract data types.

Specified by:

setObject in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the object containing the input parameter value

targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.

precision - the precision of the column.

scale - the scale of the column.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

Types, CallableStatement.getObject(int)

setAsciiStream

public final void setAsciiStream(String parameterName,
 InputStream value)
                          throws SQLException

Specified by:

setAsciiStream in interface CallableStatement

Throws:

SQLException

setAsciiStream

public final void setAsciiStream(String parameterName,
 InputStream value,
 int length)
                          throws SQLException

Specified by:

setAsciiStream in interface CallableStatement

Throws:

SQLException

setAsciiStream

public final void setAsciiStream(String parameterName,
 InputStream value,
 long length)
                          throws SQLException

Specified by:

setAsciiStream in interface CallableStatement

Throws:

SQLException

setBinaryStream

public final void setBinaryStream(String parameterName,
 InputStream value)
                           throws SQLException

Specified by:

setBinaryStream in interface CallableStatement

Throws:

SQLException

setBinaryStream

public final void setBinaryStream(String parameterName,
 InputStream value,
 int length)
                           throws SQLException

Specified by:

setBinaryStream in interface CallableStatement

Throws:

SQLException

setBinaryStream

public final void setBinaryStream(String parameterName,
 InputStream value,
 long length)
                           throws SQLException

Specified by:

setBinaryStream in interface CallableStatement

Throws:

SQLException

setBlob

public final void setBlob(String parameterName,
 Blob inputStream)
                   throws SQLException

Specified by:

setBlob in interface CallableStatement

Throws:

SQLException

setBlob

public final void setBlob(String parameterName,
 InputStream value)
                   throws SQLException

Specified by:

setBlob in interface CallableStatement

Throws:

SQLException

setBlob

public final void setBlob(String parameterName,
 InputStream inputStream,
 long length)
                   throws SQLException

Specified by:

setBlob in interface CallableStatement

Throws:

SQLException

setTimestamp

public void setTimestamp(String parameterName,
 Timestamp value)
                  throws SQLServerException

Specified by:

setTimestamp in interface CallableStatement

Throws:

SQLServerException

setTimestamp

public void setTimestamp(String parameterName,
 Timestamp value,
 int scale)
                  throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Specified by:

setTimestamp in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

scale - the scale of the parameter

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

CallableStatement.getTimestamp(int)

setTimestamp

public void setTimestamp(String parameterName,
 Timestamp value,
 int scale,
 boolean forceEncrypt)
                  throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Specified by:

setTimestamp in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

scale - the scale of the parameter

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

CallableStatement.getTimestamp(int)

setDateTimeOffset

public void setDateTimeOffset(String parameterName,
 DateTimeOffset value)
                       throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets parameter parameterName to DateTimeOffset value.

Specified by:

setDateTimeOffset in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - DateTimeOffset value

Throws:

SQLServerException - if an error occurs

setDateTimeOffset

public void setDateTimeOffset(String parameterName,
 DateTimeOffset value,
 int scale)
                       throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets parameter parameterName to DateTimeOffset value.

Specified by:

setDateTimeOffset in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - DateTimeOffset value

scale - the scale of the parameter

Throws:

SQLServerException - if an error occurs

setDateTimeOffset

public void setDateTimeOffset(String parameterName,
 DateTimeOffset value,
 int scale,
 boolean forceEncrypt)
                       throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets parameter parameterName to DateTimeOffset value.

Specified by:

setDateTimeOffset in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - DateTimeOffset value

scale - the scale of the parameter

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if an error occurs

setDate

public void setDate(String parameterName,
 Date value)
             throws SQLServerException

Specified by:

setDate in interface CallableStatement

Throws:

SQLServerException

setTime

public void setTime(String parameterName,
 Time value)
             throws SQLServerException

Specified by:

setTime in interface CallableStatement

Throws:

SQLServerException

setTime

public void setTime(String parameterName,
 Time value,
 int scale)
             throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database.

Specified by:

setTime in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

scale - the scale of the column

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

CallableStatement.getTime(int)

setTime

public void setTime(String parameterName,
 Time value,
 int scale,
 boolean forceEncrypt)
             throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database.

Specified by:

setTime in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

scale - the scale of the column

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

CallableStatement.getTime(int)

setDateTime

public void setDateTime(String parameterName,
 Timestamp value)
                 throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL DATETIME value when it sends it to the database.

Specified by:

setDateTime in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setDateTime

public void setDateTime(String parameterName,
 Timestamp value,
 boolean forceEncrypt)
                 throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL DATETIME value when it sends it to the database.

Specified by:

setDateTime in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setSmallDateTime

public void setSmallDateTime(String parameterName,
 Timestamp value)
                      throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL SMALLDATETIME value when it sends it to the database.

Specified by:

setSmallDateTime in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setSmallDateTime

public void setSmallDateTime(String parameterName,
 Timestamp value,
 boolean forceEncrypt)
                      throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL SMALLDATETIME value when it sends it to the database.

Specified by:

setSmallDateTime in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setUniqueIdentifier

public void setUniqueIdentifier(String parameterName,
 String guid)
                         throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given String value. The driver converts this to an SQL uniqueIdentifier value when it sends it to the database.

Specified by:

setUniqueIdentifier in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

guid - the parameter value

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setUniqueIdentifier

public void setUniqueIdentifier(String parameterName,
 String guid,
 boolean forceEncrypt)
                         throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given String value. The driver converts this to an SQL uniqueIdentifier value when it sends it to the database.

Specified by:

setUniqueIdentifier in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

guid - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setBytes

public void setBytes(String parameterName,
 byte[] value)
              throws SQLServerException

Specified by:

setBytes in interface CallableStatement

Throws:

SQLServerException

setBytes

public void setBytes(String parameterName,
 byte[] value,
 boolean forceEncrypt)
              throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database.

Specified by:

setBytes in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setByte

public void setByte(String parameterName,
 byte value)
             throws SQLServerException

Specified by:

setByte in interface CallableStatement

Throws:

SQLServerException

setByte

public void setByte(String parameterName,
 byte value,
 boolean forceEncrypt)
             throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database.

Specified by:

setByte in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setString

public void setString(String parameterName,
 String value)
               throws SQLServerException

Specified by:

setString in interface CallableStatement

Throws:

SQLServerException

setString

public void setString(String parameterName,
 String value,
 boolean forceEncrypt)
               throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

Specified by:

setString in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setMoney

public void setMoney(String parameterName,
 BigDecimal value)
              throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java java.math.BigDecimal value. The driver converts this to an SQL Money value.

Specified by:

setMoney in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setMoney

public void setMoney(String parameterName,
 BigDecimal value,
 boolean forceEncrypt)
              throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java java.math.BigDecimal value. The driver converts this to an SQL Money value.

Specified by:

setMoney in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setSmallMoney

public void setSmallMoney(String parameterName,
 BigDecimal value)
                   throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java java.math.BigDecimal value. The driver converts this to an SQL smallMoney value.

Specified by:

setSmallMoney in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setSmallMoney

public void setSmallMoney(String parameterName,
 BigDecimal value,
 boolean forceEncrypt)
                   throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java java.math.BigDecimal value. The driver converts this to an SQL smallMoney value.

Specified by:

setSmallMoney in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setBigDecimal

public void setBigDecimal(String parameterName,
 BigDecimal value)
                   throws SQLServerException

Specified by:

setBigDecimal in interface CallableStatement

Throws:

SQLServerException

setBigDecimal

public void setBigDecimal(String parameterName,
 BigDecimal value,
 int precision,
 int scale)
                   throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.

Specified by:

setBigDecimal in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

precision - the precision of the column

scale - the scale of the column

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setBigDecimal

public void setBigDecimal(String parameterName,
 BigDecimal value,
 int precision,
 int scale,
 boolean forceEncrypt)
                   throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.

Specified by:

setBigDecimal in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

precision - the precision of the column

scale - the scale of the column

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setDouble

public void setDouble(String parameterName,
 double value)
               throws SQLServerException

Specified by:

setDouble in interface CallableStatement

Throws:

SQLServerException

setDouble

public void setDouble(String parameterName,
 double value,
 boolean forceEncrypt)
               throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database.

Specified by:

setDouble in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setFloat

public void setFloat(String parameterName,
 float value)
              throws SQLServerException

Specified by:

setFloat in interface CallableStatement

Throws:

SQLServerException

setFloat

public void setFloat(String parameterName,
 float value,
 boolean forceEncrypt)
              throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database.

Specified by:

setFloat in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setInt

public void setInt(String parameterName,
 int value)
            throws SQLServerException

Specified by:

setInt in interface CallableStatement

Throws:

SQLServerException

setInt

public void setInt(String parameterName,
 int value,
 boolean forceEncrypt)
            throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database.

Specified by:

setInt in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setLong

public void setLong(String parameterName,
 long value)
             throws SQLServerException

Specified by:

setLong in interface CallableStatement

Throws:

SQLServerException

setLong

public void setLong(String parameterName,
 long value,
 boolean forceEncrypt)
             throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database.

Specified by:

setLong in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setShort

public void setShort(String parameterName,
 short value)
              throws SQLServerException

Specified by:

setShort in interface CallableStatement

Throws:

SQLServerException

setShort

public void setShort(String parameterName,
 short value,
 boolean forceEncrypt)
              throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database.

Specified by:

setShort in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setBoolean

public void setBoolean(String parameterName,
 boolean value)
                throws SQLServerException

Specified by:

setBoolean in interface CallableStatement

Throws:

SQLServerException

setBoolean

public void setBoolean(String parameterName,
 boolean value,
 boolean forceEncrypt)
                throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT or BOOLEAN value when it sends it to the database.

Specified by:

setBoolean in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the parameter value

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

setNull

public void setNull(String parameterName,
 int nType)
             throws SQLServerException

Specified by:

setNull in interface CallableStatement

Throws:

SQLServerException

setNull

public void setNull(String parameterName,
 int nType,
 String sTypeName)
             throws SQLServerException

Specified by:

setNull in interface CallableStatement

Throws:

SQLServerException

setURL

public void setURL(String parameterName,
 URL url)
            throws SQLException

Specified by:

setURL in interface CallableStatement

Throws:

SQLException

setStructured

public final void setStructured(String parameterName,
 String tvpName,
 SQLServerDataTable tvpDataTable)
                         throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Populates a table valued parameter passed to a stored procedure with a data table.

Specified by:

setStructured in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

tvpName - the name of the type TVP

tvpDataTable - the data table object

Throws:

SQLServerException - when an error occurs

setStructured

public final void setStructured(String parameterName,
 String tvpName,
 ResultSet tvpResultSet)
                         throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Populates a table valued parameter passed to a stored procedure with a ResultSet retrieved from another table

Specified by:

setStructured in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

tvpName - the name of the type TVP

tvpResultSet - the source result set object

Throws:

SQLServerException - when an error occurs

setStructured

public final void setStructured(String parameterName,
 String tvpName,
 ISQLServerDataRecord tvpDataRecord)
                         throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Populates a table valued parameter passed to a stored procedure with an ISQLServerDataRecord object.

Specified by:

setStructured in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

tvpName - the name of the type TVP

tvpDataRecord - ISQLServerDataRecord is used for streaming data and the user decides how to use it. tvpDataRecord is an ISQLServerDataRecord object.the source result set object

Throws:

SQLServerException - when an error occurs

getURL

public URL getURL(int parameterIndex)
           throws SQLException

Specified by:

getURL in interface CallableStatement

Throws:

SQLException

getURL

public URL getURL(String parameterName)
           throws SQLException

Specified by:

getURL in interface CallableStatement

Throws:

SQLException

setSQLXML

public final void setSQLXML(String parameterName,
 SQLXML xmlObject)
                     throws SQLException

Specified by:

setSQLXML in interface CallableStatement

Throws:

SQLException

getSQLXML

public final SQLXML getSQLXML(int parameterIndex)
                       throws SQLException

Specified by:

getSQLXML in interface CallableStatement

Throws:

SQLException

getSQLXML

public final SQLXML getSQLXML(String parameterName)
                       throws SQLException

Specified by:

getSQLXML in interface CallableStatement

Throws:

SQLException

setRowId

public final void setRowId(String parameterName,
 RowId value)
                    throws SQLException

Specified by:

setRowId in interface CallableStatement

Throws:

SQLException

getRowId

public final RowId getRowId(int parameterIndex)
                     throws SQLException

Specified by:

getRowId in interface CallableStatement

Throws:

SQLException

getRowId

public final RowId getRowId(String parameterName)
                     throws SQLException

Specified by:

getRowId in interface CallableStatement

Throws:

SQLException

registerOutParameter

public void registerOutParameter(String parameterName,
 int sqlType,
 String typeName)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(String parameterName,
 int sqlType,
 int scale)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(String parameterName,
 int sqlType,
 int precision,
 int scale)
                          throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Registers the parameter in ordinal position index to be of JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

Specified by:

registerOutParameter in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

sqlType - the JDBC type code defined by SQLType to use to register the OUT Parameter.

precision - the sum of the desired number of digits to the left and right of the decimal point. It must be greater than or equal to zero.

scale - the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

Throws:

SQLServerException - If any errors occur.

registerOutParameter

public void registerOutParameter(String parameterName,
 int sqlType)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(int parameterIndex,
 SQLType sqlType)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(int parameterIndex,
 SQLType sqlType,
 String typeName)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(int parameterIndex,
 SQLType sqlType,
 int scale)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(int parameterIndex,
 SQLType sqlType,
 int precision,
 int scale)
                          throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Registers the parameter in ordinal position index to be of JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

Specified by:

registerOutParameter in interface ISQLServerCallableStatement

Parameters:

parameterIndex - the first column is 1, the second is 2, ...

sqlType - the JDBC type code defined by SQLType to use to register the OUT Parameter.

precision - the sum of the desired number of digits to the left and right of the decimal point. It must be greater than or equal to zero.

scale - the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

Throws:

SQLServerException - If any errors occur.

setObject

public void setObject(String parameterName,
 Object value,
 SQLType jdbcType)
               throws SQLServerException

Specified by:

setObject in interface CallableStatement

Throws:

SQLServerException

setObject

public void setObject(String parameterName,
 Object value,
 SQLType jdbcType,
 int scale)
               throws SQLServerException

Specified by:

setObject in interface CallableStatement

Throws:

SQLServerException

setObject

public void setObject(String parameterName,
 Object value,
 SQLType jdbcType,
 int scale,
 boolean forceEncrypt)
               throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Sets the value of the designated parameter with the given object.

The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, java.net.URL, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Note that this method may be used to pass datatabase- specific abstract data types.

Specified by:

setObject in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

value - the object containing the input parameter value

jdbcType - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.

scale - the scale of the column.

forceEncrypt - If the boolean forceEncrypt is set to true, the query parameter will only be set if the designation column is encrypted and Always Encrypted is enabled on the connection or on the statement. If the boolean forceEncrypt is set to false, the driver will not force encryption on parameters.

Throws:

SQLServerException - if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement

See Also:

Types, CallableStatement.getObject(int)

registerOutParameter

public void registerOutParameter(String parameterName,
 SQLType sqlType,
 String typeName)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(String parameterName,
 SQLType sqlType,
 int scale)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException

registerOutParameter

public void registerOutParameter(String parameterName,
 SQLType sqlType,
 int precision,
 int scale)
                          throws SQLServerException

Description copied from interface: ISQLServerCallableStatement

Registers the parameter in ordinal position index to be of JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

Specified by:

registerOutParameter in interface ISQLServerCallableStatement

Parameters:

parameterName - the name of the parameter

sqlType - the JDBC type code defined by SQLType to use to register the OUT Parameter.

precision - the sum of the desired number of digits to the left and right of the decimal point. It must be greater than or equal to zero.

scale - the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

Throws:

SQLServerException - If any errors occur.

registerOutParameter

public void registerOutParameter(String parameterName,
 SQLType sqlType)
                          throws SQLServerException

Specified by:

registerOutParameter in interface CallableStatement

Throws:

SQLServerException