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 syntaxThe 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
isSetByIndex, isSetByName, stmtColumnEncriptionSetting, USER_DEFINED_FUNCTION_RETURN_STATUS
-
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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ArraygetArray(int parameterIndex)ArraygetArray(String parameterName)InputStreamgetAsciiStream(int parameterIndex)Returns the value of the designated column in the current row of thisResultSetobject as a stream of ASCII characters.InputStreamgetAsciiStream(String parameterName)Returns the value of the designated column in the current row of thisResultSetobject as a stream of ASCII characters.BigDecimalgetBigDecimal(int parameterIndex)BigDecimalgetBigDecimal(int parameterIndex, int scale)Deprecated.BigDecimalgetBigDecimal(String parameterName)BigDecimalgetBigDecimal(String parameterName, int scale)Deprecated.InputStreamgetBinaryStream(int parameterIndex)Returns the value of the designated column in the current row of thisResultSetobject as a stream of uninterpreted bytes.InputStreamgetBinaryStream(String parameterName)Returns the value of the designated column in the current row of thisResultSetobject as a stream of uninterpretedbytes.BlobgetBlob(int parameterIndex)BlobgetBlob(String parameterName)booleangetBoolean(int index)booleangetBoolean(String parameterName)bytegetByte(int index)bytegetByte(String parameterName)byte[]getBytes(int index)byte[]getBytes(String parameterName)ReadergetCharacterStream(int parameterIndex)ReadergetCharacterStream(String parameterName)ClobgetClob(int parameterIndex)ClobgetClob(String parameterName)DategetDate(int index)DategetDate(int index, Calendar cal)DategetDate(String parameterName)DategetDate(String parameterName, Calendar cal)TimestampgetDateTime(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.TimestampgetDateTime(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.TimestampgetDateTime(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.TimestampgetDateTime(String parameterName, 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.DateTimeOffsetgetDateTimeOffset(int index)Returns the DateTimeOffset value of parameter with index parameterIndex.DateTimeOffsetgetDateTimeOffset(String parameterName)Returns the DateTimeOffset value of parameter with name parameterName.doublegetDouble(int index)doublegetDouble(String parameterName)floatgetFloat(int index)floatgetFloat(String parameterName)intgetInt(int index)intgetInt(String parameterName)longgetLong(int index)longgetLong(String parameterName)BigDecimalgetMoney(int parameterIndex)Returns the value of the column specified as a java.math.BigDecimal object.BigDecimalgetMoney(String parameterName)Returns the value of the column specified as a java.math.BigDecimal object.ReadergetNCharacterStream(int parameterIndex)ReadergetNCharacterStream(String parameterName)NClobgetNClob(int parameterIndex)NClobgetNClob(String parameterName)StringgetNString(int parameterIndex)StringgetNString(String parameterName)ObjectgetObject(int index)<T> TgetObject(int index, Class<T> type)ObjectgetObject(int parameterIndex, Map<String,Class<?>> map)ObjectgetObject(String parameterName)<T> TgetObject(String parameterName, Class<T> type)ObjectgetObject(String parameterName, Map<String,Class<?>> m)RefgetRef(int parameterIndex)RefgetRef(String parameterName)RowIdgetRowId(int parameterIndex)RowIdgetRowId(String parameterName)shortgetShort(int index)shortgetShort(String parameterName)TimestampgetSmallDateTime(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.TimestampgetSmallDateTime(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.TimestampgetSmallDateTime(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.TimestampgetSmallDateTime(String parameterName, 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.BigDecimalgetSmallMoney(int parameterIndex)Returns the value of the column specified as a java.math.BigDecimal object.BigDecimalgetSmallMoney(String parameterName)Returns the value of the column specified as a java.math.BigDecimal object.SQLXMLgetSQLXML(int parameterIndex)SQLXMLgetSQLXML(String parameterName)StringgetString(int index)StringgetString(String parameterName)TimegetTime(int index)TimegetTime(int index, Calendar cal)TimegetTime(String parameterName)TimegetTime(String parameterName, Calendar cal)TimestampgetTimestamp(int index)TimestampgetTimestamp(int index, Calendar cal)TimestampgetTimestamp(String parameterName)TimestampgetTimestamp(String parameterName, Calendar cal)URLgetURL(int parameterIndex)URLgetURL(String parameterName)voidregisterOutParameter(int index, int sqlType)voidregisterOutParameter(int index, int sqlType, int scale)voidregisterOutParameter(int index, int sqlType, int precision, int scale)Registers the parameter in ordinal position index to be of JDBC type sqlType.voidregisterOutParameter(int index, int sqlType, String typeName)voidregisterOutParameter(int parameterIndex, SQLType sqlType)voidregisterOutParameter(int parameterIndex, SQLType sqlType, int scale)voidregisterOutParameter(int parameterIndex, SQLType sqlType, int precision, int scale)Registers the parameter in ordinal position index to be of JDBC type sqlType.voidregisterOutParameter(int parameterIndex, SQLType sqlType, String typeName)voidregisterOutParameter(String parameterName, int sqlType)voidregisterOutParameter(String parameterName, int sqlType, int scale)voidregisterOutParameter(String parameterName, int sqlType, int precision, int scale)Registers the parameter in ordinal position index to be of JDBC type sqlType.voidregisterOutParameter(String parameterName, int sqlType, String typeName)voidregisterOutParameter(String parameterName, SQLType sqlType)voidregisterOutParameter(String parameterName, SQLType sqlType, int scale)voidregisterOutParameter(String parameterName, SQLType sqlType, int precision, int scale)Registers the parameter in ordinal position index to be of JDBC type sqlType.voidregisterOutParameter(String parameterName, SQLType sqlType, String typeName)voidsetAsciiStream(String parameterName, InputStream value)voidsetAsciiStream(String parameterName, InputStream value, int length)voidsetAsciiStream(String parameterName, InputStream value, long length)voidsetBigDecimal(String parameterName, BigDecimal value)voidsetBigDecimal(String parameterName, BigDecimal value, int precision, int scale)Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBigDecimal(String parameterName, BigDecimal value, int precision, int scale, boolean forceEncrypt)Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBinaryStream(String parameterName, InputStream value)voidsetBinaryStream(String parameterName, InputStream value, int length)voidsetBinaryStream(String parameterName, InputStream value, long length)voidsetBlob(String parameterName, InputStream value)voidsetBlob(String parameterName, InputStream inputStream, long length)voidsetBlob(String parameterName, Blob inputStream)voidsetBoolean(String parameterName, boolean value)voidsetBoolean(String parameterName, boolean value, boolean forceEncrypt)Sets the designated parameter to the given Javabooleanvalue.voidsetByte(String parameterName, byte value)voidsetByte(String parameterName, byte value, boolean forceEncrypt)Sets the designated parameter to the given Javabytevalue.voidsetBytes(String parameterName, byte[] value)voidsetBytes(String parameterName, byte[] value, boolean forceEncrypt)Sets the designated parameter to the given Java array of bytes.voidsetCharacterStream(String parameterName, Reader value)voidsetCharacterStream(String parameterName, Reader value, int length)voidsetCharacterStream(String parameterName, Reader value, long length)voidsetClob(String parameterName, Reader value)voidsetClob(String parameterName, Reader value, long length)voidsetClob(String parameterName, Clob value)voidsetDate(String parameterName, Date value)voidsetDate(String parameterName, Date value, Calendar calendar)voidsetDate(String parameterName, Date value, Calendar calendar, boolean forceEncrypt)Sets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject.voidsetDateTime(String parameterName, Timestamp value)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetDateTime(String parameterName, Timestamp value, boolean forceEncrypt)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetDateTimeOffset(String parameterName, DateTimeOffset value)Sets parameter parameterName to DateTimeOffset value.voidsetDateTimeOffset(String parameterName, DateTimeOffset value, int scale)Sets parameter parameterName to DateTimeOffset value.voidsetDateTimeOffset(String parameterName, DateTimeOffset value, int scale, boolean forceEncrypt)Sets parameter parameterName to DateTimeOffset value.voidsetDouble(String parameterName, double value)voidsetDouble(String parameterName, double value, boolean forceEncrypt)Sets the designated parameter to the given Javadoublevalue.voidsetFloat(String parameterName, float value)voidsetFloat(String parameterName, float value, boolean forceEncrypt)Sets the designated parameter to the given Javafloatvalue.voidsetInt(String parameterName, int value)voidsetInt(String parameterName, int value, boolean forceEncrypt)Sets the designated parameter to the given Javaintvalue.voidsetLong(String parameterName, long value)voidsetLong(String parameterName, long value, boolean forceEncrypt)Sets the designated parameter to the given Javalongvalue.voidsetMoney(String parameterName, BigDecimal value)Sets the designated parameter to the given Javajava.math.BigDecimalvalue.voidsetMoney(String parameterName, BigDecimal value, boolean forceEncrypt)Sets the designated parameter to the given Javajava.math.BigDecimalvalue.voidsetNCharacterStream(String parameterName, Reader value)voidsetNCharacterStream(String parameterName, Reader value, long length)voidsetNClob(String parameterName, Reader value)voidsetNClob(String parameterName, Reader value, long length)voidsetNClob(String parameterName, NClob value)voidsetNString(String parameterName, String value)voidsetNString(String parameterName, String value, boolean forceEncrypt)Sets the designated parameter to the givenStringobject.voidsetNull(String parameterName, int nType)voidsetNull(String parameterName, int nType, String sTypeName)voidsetObject(String parameterName, Object value)voidsetObject(String parameterName, Object value, int sqlType)voidsetObject(String parameterName, Object value, int sqlType, int decimals)voidsetObject(String parameterName, Object value, int sqlType, int decimals, boolean forceEncrypt)Sets the value of the designated parameter with the given object.voidsetObject(String parameterName, Object value, int targetSqlType, Integer precision, int scale)Sets the value of the designated parameter with the given object.voidsetObject(String parameterName, Object value, SQLType jdbcType)voidsetObject(String parameterName, Object value, SQLType jdbcType, int scale)voidsetObject(String parameterName, Object value, SQLType jdbcType, int scale, boolean forceEncrypt)Sets the value of the designated parameter with the given object.voidsetRowId(String parameterName, RowId value)voidsetShort(String parameterName, short value)voidsetShort(String parameterName, short value, boolean forceEncrypt)Sets the designated parameter to the given Javashortvalue.voidsetSmallDateTime(String parameterName, Timestamp value)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetSmallDateTime(String parameterName, Timestamp value, boolean forceEncrypt)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetSmallMoney(String parameterName, BigDecimal value)Sets the designated parameter to the given Javajava.math.BigDecimalvalue.voidsetSmallMoney(String parameterName, BigDecimal value, boolean forceEncrypt)Sets the designated parameter to the given Javajava.math.BigDecimalvalue.voidsetSQLXML(String parameterName, SQLXML xmlObject)voidsetString(String parameterName, String value)voidsetString(String parameterName, String value, boolean forceEncrypt)Sets the designated parameter to the given JavaStringvalue.voidsetStructured(String parameterName, String tvpName, ISQLServerDataRecord tvpDataRecord)Populates a table valued parameter passed to a stored procedure with an ISQLServerDataRecord object.voidsetStructured(String parameterName, String tvpName, SQLServerDataTable tvpDataTable)Populates a table valued parameter passed to a stored procedure with a data table.voidsetStructured(String parameterName, String tvpName, ResultSet tvpResultSet)Populates a table valued parameter passed to a stored procedure with a ResultSet retrieved from another tablevoidsetTime(String parameterName, Time value)voidsetTime(String parameterName, Time value, int scale)Sets the designated parameter to the givenjava.sql.Timevalue.voidsetTime(String parameterName, Time value, int scale, boolean forceEncrypt)Sets the designated parameter to the givenjava.sql.Timevalue.voidsetTime(String parameterName, Time value, Calendar calendar)voidsetTime(String parameterName, Time value, Calendar calendar, boolean forceEncrypt)Sets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject.voidsetTimestamp(String parameterName, Timestamp value)voidsetTimestamp(String parameterName, Timestamp value, int scale)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(String parameterName, Timestamp value, int scale, boolean forceEncrypt)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(String parameterName, Timestamp value, Calendar calendar)voidsetTimestamp(String parameterName, Timestamp value, Calendar calendar, boolean forceEncrypt)Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetUniqueIdentifier(String parameterName, String guid)Sets the designated parameter to the givenStringvalue.voidsetUniqueIdentifier(String parameterName, String guid, boolean forceEncrypt)Sets the designated parameter to the givenStringvalue.voidsetURL(String parameterName, URL url)booleanwasNull()-
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, toString
-
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, registerColumnEncryptionKeyStoreProvidersOnStatement, setCancelQueryTimeout, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout, setResponseBuffering, 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 Detail
-
registerOutParameter
public void registerOutParameter(int index, int sqlType) throws SQLServerException- Specified by:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(int index, int sqlType, String typeName) throws SQLServerException- Specified by:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(int index, int sqlType, int scale) throws SQLServerException- Specified by:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(int index, int sqlType, int precision, int scale) throws SQLServerExceptionDescription copied from interface:ISQLServerCallableStatementRegisters 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:
registerOutParameterin interfaceISQLServerCallableStatement- 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:
getIntin interfaceCallableStatement- Throws:
SQLServerException
-
getInt
public int getInt(String parameterName) throws SQLServerException
- Specified by:
getIntin interfaceCallableStatement- Throws:
SQLServerException
-
getString
public String getString(int index) throws SQLServerException
- Specified by:
getStringin interfaceCallableStatement- Throws:
SQLServerException
-
getString
public String getString(String parameterName) throws SQLServerException
- Specified by:
getStringin interfaceCallableStatement- Throws:
SQLServerException
-
getNString
public final String getNString(int parameterIndex) throws SQLException
- Specified by:
getNStringin interfaceCallableStatement- Throws:
SQLException
-
getNString
public final String getNString(String parameterName) throws SQLException
- Specified by:
getNStringin interfaceCallableStatement- Throws:
SQLException
-
getBigDecimal
@Deprecated(since="6.5.4") public BigDecimal getBigDecimal(int parameterIndex, int scale) throws SQLException
Deprecated.- Specified by:
getBigDecimalin interfaceCallableStatement- Throws:
SQLException
-
getBigDecimal
@Deprecated(since="6.5.4") public BigDecimal getBigDecimal(String parameterName, int scale) throws SQLServerException
Deprecated.Description copied from interface:ISQLServerCallableStatementReturns 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:
getBigDecimalin interfaceISQLServerCallableStatement- Parameters:
parameterName- the label for the columnscale- 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:
getBooleanin interfaceCallableStatement- Throws:
SQLServerException
-
getBoolean
public boolean getBoolean(String parameterName) throws SQLServerException
- Specified by:
getBooleanin interfaceCallableStatement- Throws:
SQLServerException
-
getByte
public byte getByte(int index) throws SQLServerException- Specified by:
getBytein interfaceCallableStatement- Throws:
SQLServerException
-
getByte
public byte getByte(String parameterName) throws SQLServerException
- Specified by:
getBytein interfaceCallableStatement- Throws:
SQLServerException
-
getBytes
public byte[] getBytes(int index) throws SQLServerException- Specified by:
getBytesin interfaceCallableStatement- Throws:
SQLServerException
-
getBytes
public byte[] getBytes(String parameterName) throws SQLServerException
- Specified by:
getBytesin interfaceCallableStatement- Throws:
SQLServerException
-
getDate
public Date getDate(int index) throws SQLServerException
- Specified by:
getDatein interfaceCallableStatement- Throws:
SQLServerException
-
getDate
public Date getDate(String parameterName) throws SQLServerException
- Specified by:
getDatein interfaceCallableStatement- Throws:
SQLServerException
-
getDate
public Date getDate(int index, Calendar cal) throws SQLServerException
- Specified by:
getDatein interfaceCallableStatement- Throws:
SQLServerException
-
getDate
public Date getDate(String parameterName, Calendar cal) throws SQLServerException
- Specified by:
getDatein interfaceCallableStatement- Throws:
SQLServerException
-
getDouble
public double getDouble(int index) throws SQLServerException- Specified by:
getDoublein interfaceCallableStatement- Throws:
SQLServerException
-
getDouble
public double getDouble(String parameterName) throws SQLServerException
- Specified by:
getDoublein interfaceCallableStatement- Throws:
SQLServerException
-
getFloat
public float getFloat(int index) throws SQLServerException- Specified by:
getFloatin interfaceCallableStatement- Throws:
SQLServerException
-
getFloat
public float getFloat(String parameterName) throws SQLServerException
- Specified by:
getFloatin interfaceCallableStatement- Throws:
SQLServerException
-
getLong
public long getLong(int index) throws SQLServerException- Specified by:
getLongin interfaceCallableStatement- Throws:
SQLServerException
-
getLong
public long getLong(String parameterName) throws SQLServerException
- Specified by:
getLongin interfaceCallableStatement- Throws:
SQLServerException
-
getObject
public Object getObject(int index) throws SQLServerException
- Specified by:
getObjectin interfaceCallableStatement- Throws:
SQLServerException
-
getObject
public <T> T getObject(int index, Class<T> type) throws SQLException- Specified by:
getObjectin interfaceCallableStatement- Throws:
SQLException
-
getObject
public Object getObject(String parameterName) throws SQLServerException
- Specified by:
getObjectin interfaceCallableStatement- Throws:
SQLServerException
-
getObject
public <T> T getObject(String parameterName, Class<T> type) throws SQLException
- Specified by:
getObjectin interfaceCallableStatement- Throws:
SQLException
-
getShort
public short getShort(int index) throws SQLServerException- Specified by:
getShortin interfaceCallableStatement- Throws:
SQLServerException
-
getShort
public short getShort(String parameterName) throws SQLServerException
- Specified by:
getShortin interfaceCallableStatement- Throws:
SQLServerException
-
getTime
public Time getTime(int index) throws SQLServerException
- Specified by:
getTimein interfaceCallableStatement- Throws:
SQLServerException
-
getTime
public Time getTime(String parameterName) throws SQLServerException
- Specified by:
getTimein interfaceCallableStatement- Throws:
SQLServerException
-
getTime
public Time getTime(int index, Calendar cal) throws SQLServerException
- Specified by:
getTimein interfaceCallableStatement- Throws:
SQLServerException
-
getTime
public Time getTime(String parameterName, Calendar cal) throws SQLServerException
- Specified by:
getTimein interfaceCallableStatement- Throws:
SQLServerException
-
getTimestamp
public Timestamp getTimestamp(int index) throws SQLServerException
- Specified by:
getTimestampin interfaceCallableStatement- Throws:
SQLServerException
-
getTimestamp
public Timestamp getTimestamp(String parameterName) throws SQLServerException
- Specified by:
getTimestampin interfaceCallableStatement- Throws:
SQLServerException
-
getTimestamp
public Timestamp getTimestamp(int index, Calendar cal) throws SQLServerException
- Specified by:
getTimestampin interfaceCallableStatement- Throws:
SQLServerException
-
getTimestamp
public Timestamp getTimestamp(String parameterName, Calendar cal) throws SQLServerException
- Specified by:
getTimestampin interfaceCallableStatement- Throws:
SQLServerException
-
getDateTime
public Timestamp getDateTime(int index) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementReturns 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:
getDateTimein interfaceISQLServerCallableStatement- 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:ISQLServerCallableStatementReturns 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:
getDateTimein interfaceISQLServerCallableStatement- 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:ISQLServerCallableStatementReturns 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:
getDateTimein interfaceISQLServerCallableStatement- 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 parameterName, Calendar cal) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementReturns 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:
getDateTimein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the columncal- 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:ISQLServerCallableStatementReturns 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:
getSmallDateTimein interfaceISQLServerCallableStatement- 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:ISQLServerCallableStatementReturns 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:
getSmallDateTimein interfaceISQLServerCallableStatement- 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:ISQLServerCallableStatementReturns 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:
getSmallDateTimein interfaceISQLServerCallableStatement- 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 parameterName, Calendar cal) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementReturns 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:
getSmallDateTimein interfaceISQLServerCallableStatement- Parameters:
parameterName- The name of a columncal- 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:ISQLServerCallableStatementReturns the DateTimeOffset value of parameter with index parameterIndex.- Specified by:
getDateTimeOffsetin interfaceISQLServerCallableStatement- 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 closedCallableStatement
-
getDateTimeOffset
public DateTimeOffset getDateTimeOffset(String parameterName) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementReturns the DateTimeOffset value of parameter with name parameterName.- Specified by:
getDateTimeOffsetin interfaceISQLServerCallableStatement- 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 closedCallableStatement
-
wasNull
public boolean wasNull() throws SQLServerException- Specified by:
wasNullin interfaceCallableStatement- Throws:
SQLServerException
-
getAsciiStream
public final InputStream getAsciiStream(int parameterIndex) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementReturns the value of the designated column in the current row of thisResultSetobject as a stream of ASCII characters. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving largeLONGVARCHARvalues. 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
0when the methodInputStream.availableis called whether there is data available or not.- Specified by:
getAsciiStreamin interfaceISQLServerCallableStatement- 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 isnull - 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:ISQLServerCallableStatementReturns the value of the designated column in the current row of thisResultSetobject as a stream of ASCII characters. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving largeLONGVARCHARvalues. 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
0when the methodavailableis called whether there is data available or not.- Specified by:
getAsciiStreamin interfaceISQLServerCallableStatement- 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 isnull. - 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:
getBigDecimalin interfaceCallableStatement- Throws:
SQLServerException
-
getBigDecimal
public BigDecimal getBigDecimal(String parameterName) throws SQLServerException
- Specified by:
getBigDecimalin interfaceCallableStatement- Throws:
SQLServerException
-
getMoney
public BigDecimal getMoney(int parameterIndex) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementReturns the value of the column specified as a java.math.BigDecimal object.- Specified by:
getMoneyin interfaceISQLServerCallableStatement- 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:ISQLServerCallableStatementReturns the value of the column specified as a java.math.BigDecimal object.- Specified by:
getMoneyin interfaceISQLServerCallableStatement- 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:ISQLServerCallableStatementReturns the value of the column specified as a java.math.BigDecimal object.- Specified by:
getSmallMoneyin interfaceISQLServerCallableStatement- 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:ISQLServerCallableStatementReturns the value of the column specified as a java.math.BigDecimal object.- Specified by:
getSmallMoneyin interfaceISQLServerCallableStatement- 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:ISQLServerCallableStatementReturns the value of the designated column in the current row of thisResultSetobject as a stream of uninterpreted bytes. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving largeLONGVARBINARYvalues.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
0when the methodInputStream.availableis called whether there is data available or not.- Specified by:
getBinaryStreamin interfaceISQLServerCallableStatement- 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 isnull - 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:ISQLServerCallableStatementReturns the value of the designated column in the current row of thisResultSetobject as a stream of uninterpretedbytes. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving largeLONGVARBINARYvalues.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
0when the methodavailableis called whether there is data available or not.- Specified by:
getBinaryStreamin interfaceISQLServerCallableStatement- 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 isnull - 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:
getBlobin interfaceCallableStatement- Throws:
SQLServerException
-
getBlob
public Blob getBlob(String parameterName) throws SQLServerException
- Specified by:
getBlobin interfaceCallableStatement- Throws:
SQLServerException
-
getCharacterStream
public final Reader getCharacterStream(int parameterIndex) throws SQLServerException
- Specified by:
getCharacterStreamin interfaceCallableStatement- Throws:
SQLServerException
-
getCharacterStream
public final Reader getCharacterStream(String parameterName) throws SQLException
- Specified by:
getCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
getNCharacterStream
public final Reader getNCharacterStream(int parameterIndex) throws SQLException
- Specified by:
getNCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
getNCharacterStream
public final Reader getNCharacterStream(String parameterName) throws SQLException
- Specified by:
getNCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
getClob
public Clob getClob(int parameterIndex) throws SQLServerException
- Specified by:
getClobin interfaceCallableStatement- Throws:
SQLServerException
-
getClob
public Clob getClob(String parameterName) throws SQLServerException
- Specified by:
getClobin interfaceCallableStatement- Throws:
SQLServerException
-
getNClob
public NClob getNClob(int parameterIndex) throws SQLException
- Specified by:
getNClobin interfaceCallableStatement- Throws:
SQLException
-
getNClob
public NClob getNClob(String parameterName) throws SQLException
- Specified by:
getNClobin interfaceCallableStatement- Throws:
SQLException
-
getObject
public Object getObject(int parameterIndex, Map<String,Class<?>> map) throws SQLException
- Specified by:
getObjectin interfaceCallableStatement- Throws:
SQLException
-
getObject
public Object getObject(String parameterName, Map<String,Class<?>> m) throws SQLException
- Specified by:
getObjectin interfaceCallableStatement- Throws:
SQLException
-
getRef
public Ref getRef(int parameterIndex) throws SQLException
- Specified by:
getRefin interfaceCallableStatement- Throws:
SQLException
-
getRef
public Ref getRef(String parameterName) throws SQLException
- Specified by:
getRefin interfaceCallableStatement- Throws:
SQLException
-
getArray
public Array getArray(int parameterIndex) throws SQLException
- Specified by:
getArrayin interfaceCallableStatement- Throws:
SQLException
-
getArray
public Array getArray(String parameterName) throws SQLException
- Specified by:
getArrayin interfaceCallableStatement- Throws:
SQLException
-
setTimestamp
public void setTimestamp(String parameterName, Timestamp value, Calendar calendar) throws SQLServerException
- Specified by:
setTimestampin interfaceCallableStatement- Throws:
SQLServerException
-
setTimestamp
public void setTimestamp(String parameterName, Timestamp value, Calendar calendar, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.- Specified by:
setTimestampin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valuecalendar- a java.util.CalendarforceEncrypt- 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 closedCallableStatement- See Also:
CallableStatement.getTimestamp(int)
-
setTime
public void setTime(String parameterName, Time value, Calendar calendar) throws SQLServerException
- Specified by:
setTimein interfaceCallableStatement- Throws:
SQLServerException
-
setTime
public void setTime(String parameterName, Time value, Calendar calendar, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMEvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the time taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTimein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valuecalendar- theCalendarobject the driver will use to construct the timeforceEncrypt- 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 closedCallableStatement- See Also:
CallableStatement.getTime(int)
-
setDate
public void setDate(String parameterName, Date value, Calendar calendar) throws SQLServerException
- Specified by:
setDatein interfaceCallableStatement- Throws:
SQLServerException
-
setDate
public void setDate(String parameterName, Date value, Calendar calendar, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLDATEvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the date taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setDatein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valuecalendar- theCalendarobject the driver will use to construct the dateforceEncrypt- 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 closedCallableStatement- See Also:
CallableStatement.getDate(int)
-
setCharacterStream
public final void setCharacterStream(String parameterName, Reader value) throws SQLException
- Specified by:
setCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
setCharacterStream
public final void setCharacterStream(String parameterName, Reader value, int length) throws SQLException
- Specified by:
setCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
setCharacterStream
public final void setCharacterStream(String parameterName, Reader value, long length) throws SQLException
- Specified by:
setCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
setNCharacterStream
public final void setNCharacterStream(String parameterName, Reader value) throws SQLException
- Specified by:
setNCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
setNCharacterStream
public final void setNCharacterStream(String parameterName, Reader value, long length) throws SQLException
- Specified by:
setNCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
setClob
public final void setClob(String parameterName, Clob value) throws SQLException
- Specified by:
setClobin interfaceCallableStatement- Throws:
SQLException
-
setClob
public final void setClob(String parameterName, Reader value) throws SQLException
- Specified by:
setClobin interfaceCallableStatement- Throws:
SQLException
-
setClob
public final void setClob(String parameterName, Reader value, long length) throws SQLException
- Specified by:
setClobin interfaceCallableStatement- Throws:
SQLException
-
setNClob
public final void setNClob(String parameterName, NClob value) throws SQLException
- Specified by:
setNClobin interfaceCallableStatement- Throws:
SQLException
-
setNClob
public final void setNClob(String parameterName, Reader value) throws SQLException
- Specified by:
setNClobin interfaceCallableStatement- Throws:
SQLException
-
setNClob
public final void setNClob(String parameterName, Reader value, long length) throws SQLException
- Specified by:
setNClobin interfaceCallableStatement- Throws:
SQLException
-
setNString
public final void setNString(String parameterName, String value) throws SQLException
- Specified by:
setNStringin interfaceCallableStatement- Throws:
SQLException
-
setNString
public final void setNString(String parameterName, String value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenStringobject. The driver converts this to a SQLNCHARorNVARCHARorLONGNVARCHAR- Specified by:
setNStringin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parameter to be setvalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setObject
public void setObject(String parameterName, Object value) throws SQLServerException
- Specified by:
setObjectin interfaceCallableStatement- Throws:
SQLServerException
-
setObject
public void setObject(String parameterName, Object value, int sqlType) throws SQLServerException
- Specified by:
setObjectin interfaceCallableStatement- Throws:
SQLServerException
-
setObject
public void setObject(String parameterName, Object value, int sqlType, int decimals) throws SQLServerException
- Specified by:
setObjectin interfaceCallableStatement- Throws:
SQLServerException
-
setObject
public void setObject(String parameterName, Object value, int sqlType, int decimals, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets 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 methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, 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:
setObjectin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the object containing the input parameter valuesqlType- 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 closedCallableStatement- 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:ISQLServerCallableStatementSets 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 methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, 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:
setObjectin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the object containing the input parameter valuetargetSqlType- 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 closedCallableStatement- See Also:
Types,CallableStatement.getObject(int)
-
setAsciiStream
public final void setAsciiStream(String parameterName, InputStream value) throws SQLException
- Specified by:
setAsciiStreamin interfaceCallableStatement- Throws:
SQLException
-
setAsciiStream
public final void setAsciiStream(String parameterName, InputStream value, int length) throws SQLException
- Specified by:
setAsciiStreamin interfaceCallableStatement- Throws:
SQLException
-
setAsciiStream
public final void setAsciiStream(String parameterName, InputStream value, long length) throws SQLException
- Specified by:
setAsciiStreamin interfaceCallableStatement- Throws:
SQLException
-
setBinaryStream
public final void setBinaryStream(String parameterName, InputStream value) throws SQLException
- Specified by:
setBinaryStreamin interfaceCallableStatement- Throws:
SQLException
-
setBinaryStream
public final void setBinaryStream(String parameterName, InputStream value, int length) throws SQLException
- Specified by:
setBinaryStreamin interfaceCallableStatement- Throws:
SQLException
-
setBinaryStream
public final void setBinaryStream(String parameterName, InputStream value, long length) throws SQLException
- Specified by:
setBinaryStreamin interfaceCallableStatement- Throws:
SQLException
-
setBlob
public final void setBlob(String parameterName, Blob inputStream) throws SQLException
- Specified by:
setBlobin interfaceCallableStatement- Throws:
SQLException
-
setBlob
public final void setBlob(String parameterName, InputStream value) throws SQLException
- Specified by:
setBlobin interfaceCallableStatement- Throws:
SQLException
-
setBlob
public final void setBlob(String parameterName, InputStream inputStream, long length) throws SQLException
- Specified by:
setBlobin interfaceCallableStatement- Throws:
SQLException
-
setTimestamp
public void setTimestamp(String parameterName, Timestamp value) throws SQLServerException
- Specified by:
setTimestampin interfaceCallableStatement- Throws:
SQLServerException
-
setTimestamp
public void setTimestamp(String parameterName, Timestamp value, int scale) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.- Specified by:
setTimestampin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valuescale- 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 closedCallableStatement- See Also:
CallableStatement.getTimestamp(int)
-
setTimestamp
public void setTimestamp(String parameterName, Timestamp value, int scale, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.- Specified by:
setTimestampin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valuescale- the scale of the parameterforceEncrypt- 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 closedCallableStatement- See Also:
CallableStatement.getTimestamp(int)
-
setDateTimeOffset
public void setDateTimeOffset(String parameterName, DateTimeOffset value) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets parameter parameterName to DateTimeOffset value.- Specified by:
setDateTimeOffsetin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- DateTimeOffset value- Throws:
SQLServerException- if an error occurs
-
setDateTimeOffset
public void setDateTimeOffset(String parameterName, DateTimeOffset value, int scale) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets parameter parameterName to DateTimeOffset value.- Specified by:
setDateTimeOffsetin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- DateTimeOffset valuescale- 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:ISQLServerCallableStatementSets parameter parameterName to DateTimeOffset value.- Specified by:
setDateTimeOffsetin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- DateTimeOffset valuescale- the scale of the parameterforceEncrypt- 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:
setDatein interfaceCallableStatement- Throws:
SQLServerException
-
setTime
public void setTime(String parameterName, Time value) throws SQLServerException
- Specified by:
setTimein interfaceCallableStatement- Throws:
SQLServerException
-
setTime
public void setTime(String parameterName, Time value, int scale) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.- Specified by:
setTimein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valuescale- 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 closedCallableStatement- See Also:
CallableStatement.getTime(int)
-
setTime
public void setTime(String parameterName, Time value, int scale, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.- Specified by:
setTimein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valuescale- the scale of the columnforceEncrypt- 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 closedCallableStatement- See Also:
CallableStatement.getTime(int)
-
setDateTime
public void setDateTime(String parameterName, Timestamp value) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLDATETIMEvalue when it sends it to the database.- Specified by:
setDateTimein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- 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 closedCallableStatement
-
setDateTime
public void setDateTime(String parameterName, Timestamp value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLDATETIMEvalue when it sends it to the database.- Specified by:
setDateTimein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setSmallDateTime
public void setSmallDateTime(String parameterName, Timestamp value) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLSMALLDATETIMEvalue when it sends it to the database.- Specified by:
setSmallDateTimein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- 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 closedCallableStatement
-
setSmallDateTime
public void setSmallDateTime(String parameterName, Timestamp value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.sql.Timestampvalue. The driver converts this to an SQLSMALLDATETIMEvalue when it sends it to the database.- Specified by:
setSmallDateTimein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setUniqueIdentifier
public void setUniqueIdentifier(String parameterName, String guid) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenStringvalue. The driver converts this to an SQLuniqueIdentifiervalue when it sends it to the database.- Specified by:
setUniqueIdentifierin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parameterguid- 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 closedCallableStatement
-
setUniqueIdentifier
public void setUniqueIdentifier(String parameterName, String guid, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenStringvalue. The driver converts this to an SQLuniqueIdentifiervalue when it sends it to the database.- Specified by:
setUniqueIdentifierin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parameterguid- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setBytes
public void setBytes(String parameterName, byte[] value) throws SQLServerException
- Specified by:
setBytesin interfaceCallableStatement- Throws:
SQLServerException
-
setBytes
public void setBytes(String parameterName, byte[] value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARYorLONGVARBINARY(depending on the argument's size relative to the driver's limits onVARBINARYvalues) when it sends it to the database.- Specified by:
setBytesin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setByte
public void setByte(String parameterName, byte value) throws SQLServerException
- Specified by:
setBytein interfaceCallableStatement- Throws:
SQLServerException
-
setByte
public void setByte(String parameterName, byte value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database.- Specified by:
setBytein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setString
public void setString(String parameterName, String value) throws SQLServerException
- Specified by:
setStringin interfaceCallableStatement- Throws:
SQLServerException
-
setString
public void setString(String parameterName, String value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given JavaStringvalue. The driver converts this to an SQLVARCHARorLONGVARCHARvalue (depending on the argument's size relative to the driver's limits onVARCHARvalues) when it sends it to the database.- Specified by:
setStringin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setMoney
public void setMoney(String parameterName, BigDecimal value) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javajava.math.BigDecimalvalue. The driver converts this to an SQLMoneyvalue.- Specified by:
setMoneyin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- 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 closedCallableStatement
-
setMoney
public void setMoney(String parameterName, BigDecimal value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javajava.math.BigDecimalvalue. The driver converts this to an SQLMoneyvalue.- Specified by:
setMoneyin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setSmallMoney
public void setSmallMoney(String parameterName, BigDecimal value) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javajava.math.BigDecimalvalue. The driver converts this to an SQLsmallMoneyvalue.- Specified by:
setSmallMoneyin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- 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 closedCallableStatement
-
setSmallMoney
public void setSmallMoney(String parameterName, BigDecimal value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javajava.math.BigDecimalvalue. The driver converts this to an SQLsmallMoneyvalue.- Specified by:
setSmallMoneyin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setBigDecimal
public void setBigDecimal(String parameterName, BigDecimal value) throws SQLServerException
- Specified by:
setBigDecimalin interfaceCallableStatement- Throws:
SQLServerException
-
setBigDecimal
public void setBigDecimal(String parameterName, BigDecimal value, int precision, int scale) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.- Specified by:
setBigDecimalin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueprecision- the precision of the columnscale- 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 closedCallableStatement
-
setBigDecimal
public void setBigDecimal(String parameterName, BigDecimal value, int precision, int scale, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the givenjava.math.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.- Specified by:
setBigDecimalin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueprecision- the precision of the columnscale- the scale of the columnforceEncrypt- 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 closedCallableStatement
-
setDouble
public void setDouble(String parameterName, double value) throws SQLServerException
- Specified by:
setDoublein interfaceCallableStatement- Throws:
SQLServerException
-
setDouble
public void setDouble(String parameterName, double value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database.- Specified by:
setDoublein interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setFloat
public void setFloat(String parameterName, float value) throws SQLServerException
- Specified by:
setFloatin interfaceCallableStatement- Throws:
SQLServerException
-
setFloat
public void setFloat(String parameterName, float value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javafloatvalue. The driver converts this to an SQLFLOATvalue when it sends it to the database.- Specified by:
setFloatin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setInt
public void setInt(String parameterName, int value) throws SQLServerException
- Specified by:
setIntin interfaceCallableStatement- Throws:
SQLServerException
-
setInt
public void setInt(String parameterName, int value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database.- Specified by:
setIntin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setLong
public void setLong(String parameterName, long value) throws SQLServerException
- Specified by:
setLongin interfaceCallableStatement- Throws:
SQLServerException
-
setLong
public void setLong(String parameterName, long value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database.- Specified by:
setLongin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setShort
public void setShort(String parameterName, short value) throws SQLServerException
- Specified by:
setShortin interfaceCallableStatement- Throws:
SQLServerException
-
setShort
public void setShort(String parameterName, short value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database.- Specified by:
setShortin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setBoolean
public void setBoolean(String parameterName, boolean value) throws SQLServerException
- Specified by:
setBooleanin interfaceCallableStatement- Throws:
SQLServerException
-
setBoolean
public void setBoolean(String parameterName, boolean value, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets the designated parameter to the given Javabooleanvalue. The driver converts this to an SQLBITorBOOLEANvalue when it sends it to the database.- Specified by:
setBooleanin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the parameter valueforceEncrypt- 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 closedCallableStatement
-
setNull
public void setNull(String parameterName, int nType) throws SQLServerException
- Specified by:
setNullin interfaceCallableStatement- Throws:
SQLServerException
-
setNull
public void setNull(String parameterName, int nType, String sTypeName) throws SQLServerException
- Specified by:
setNullin interfaceCallableStatement- Throws:
SQLServerException
-
setURL
public void setURL(String parameterName, URL url) throws SQLException
- Specified by:
setURLin interfaceCallableStatement- Throws:
SQLException
-
setStructured
public final void setStructured(String parameterName, String tvpName, SQLServerDataTable tvpDataTable) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementPopulates a table valued parameter passed to a stored procedure with a data table.- Specified by:
setStructuredin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametertvpName- the name of the type TVPtvpDataTable- 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:ISQLServerCallableStatementPopulates a table valued parameter passed to a stored procedure with a ResultSet retrieved from another table- Specified by:
setStructuredin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametertvpName- the name of the type TVPtvpResultSet- 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:ISQLServerCallableStatementPopulates a table valued parameter passed to a stored procedure with an ISQLServerDataRecord object.- Specified by:
setStructuredin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametertvpName- the name of the type TVPtvpDataRecord- 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:
getURLin interfaceCallableStatement- Throws:
SQLException
-
getURL
public URL getURL(String parameterName) throws SQLException
- Specified by:
getURLin interfaceCallableStatement- Throws:
SQLException
-
setSQLXML
public final void setSQLXML(String parameterName, SQLXML xmlObject) throws SQLException
- Specified by:
setSQLXMLin interfaceCallableStatement- Throws:
SQLException
-
getSQLXML
public final SQLXML getSQLXML(int parameterIndex) throws SQLException
- Specified by:
getSQLXMLin interfaceCallableStatement- Throws:
SQLException
-
getSQLXML
public final SQLXML getSQLXML(String parameterName) throws SQLException
- Specified by:
getSQLXMLin interfaceCallableStatement- Throws:
SQLException
-
setRowId
public final void setRowId(String parameterName, RowId value) throws SQLException
- Specified by:
setRowIdin interfaceCallableStatement- Throws:
SQLException
-
getRowId
public final RowId getRowId(int parameterIndex) throws SQLException
- Specified by:
getRowIdin interfaceCallableStatement- Throws:
SQLException
-
getRowId
public final RowId getRowId(String parameterName) throws SQLException
- Specified by:
getRowIdin interfaceCallableStatement- Throws:
SQLException
-
registerOutParameter
public void registerOutParameter(String parameterName, int sqlType, String typeName) throws SQLServerException
- Specified by:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(String parameterName, int sqlType, int scale) throws SQLServerException
- Specified by:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(String parameterName, int sqlType, int precision, int scale) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementRegisters 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:
registerOutParameterin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametersqlType- 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:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(int parameterIndex, SQLType sqlType) throws SQLServerException- Specified by:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(int parameterIndex, SQLType sqlType, String typeName) throws SQLServerException- Specified by:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(int parameterIndex, SQLType sqlType, int scale) throws SQLServerException- Specified by:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(int parameterIndex, SQLType sqlType, int precision, int scale) throws SQLServerExceptionDescription copied from interface:ISQLServerCallableStatementRegisters 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:
registerOutParameterin interfaceISQLServerCallableStatement- 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:
setObjectin interfaceCallableStatement- Throws:
SQLServerException
-
setObject
public void setObject(String parameterName, Object value, SQLType jdbcType, int scale) throws SQLServerException
- Specified by:
setObjectin interfaceCallableStatement- Throws:
SQLServerException
-
setObject
public void setObject(String parameterName, Object value, SQLType jdbcType, int scale, boolean forceEncrypt) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementSets 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 methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, 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:
setObjectin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametervalue- the object containing the input parameter valuejdbcType- 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 closedCallableStatement- See Also:
Types,CallableStatement.getObject(int)
-
registerOutParameter
public void registerOutParameter(String parameterName, SQLType sqlType, String typeName) throws SQLServerException
- Specified by:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(String parameterName, SQLType sqlType, int scale) throws SQLServerException
- Specified by:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
registerOutParameter
public void registerOutParameter(String parameterName, SQLType sqlType, int precision, int scale) throws SQLServerException
Description copied from interface:ISQLServerCallableStatementRegisters 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:
registerOutParameterin interfaceISQLServerCallableStatement- Parameters:
parameterName- the name of the parametersqlType- 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:
registerOutParameterin interfaceCallableStatement- Throws:
SQLServerException
-
-