Package com.microsoft.sqlserver.jdbc
Class SQLServerError
- java.lang.Object
-
- com.microsoft.sqlserver.jdbc.SQLServerError
-
- All Implemented Interfaces:
ISQLServerMessage,Serializable
public final class SQLServerError extends Object implements Serializable, ISQLServerMessage
SQLServerError represents a TDS error or message event.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetErrorMessage()Returns error message as received from SQL ServerintgetErrorNumber()Returns error number as received from SQL ServerintgetErrorSeverity()Returns Severity of error (as int value) as received from SQL ServerintgetErrorState()Returns error state as received from SQL ServerlonggetLineNumber()Returns line number where the error occurred in Stored Procedure returned bygetProcedureName()as received from SQL ServerStringgetProcedureName()Returns name of the stored procedure where exception occurs as received from SQL ServerStringgetServerName()Returns name of the server where exception occurs as received from SQL ServerSQLServerErrorgetSQLServerMessage()Returns SQLServerError containing detailed info about SQL Server Message as received from SQL Server.voidsetErrorNumber(int newErrorNumber)Set a new ErrorNumber for this MessagevoidsetErrorSeverity(int newSeverity)Set a new ErrorSeverity for this MessageSQLExceptiontoSqlExceptionOrSqlWarning()Creates a SQLServerException or SQLServerWarning from this SQLServerMessageISQLServerMessagetoSQLServerInfoMessage()Downgrade a Error message into a Info messageISQLServerMessagetoSQLServerInfoMessage(int newErrorSeverity)Downgrade a Error message into a Info messageISQLServerMessagetoSQLServerInfoMessage(int newErrorSeverity, int newErrorNumber)Downgrade a Error message into a Info message-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.microsoft.sqlserver.jdbc.ISQLServerMessage
isErrorMessage, isInfoMessage
-
-
-
-
Method Detail
-
getErrorMessage
public String getErrorMessage()
Returns error message as received from SQL Server- Specified by:
getErrorMessagein interfaceISQLServerMessage- Returns:
- Error Message
-
getErrorNumber
public int getErrorNumber()
Returns error number as received from SQL Server- Specified by:
getErrorNumberin interfaceISQLServerMessage- Returns:
- Error Number
-
getErrorState
public int getErrorState()
Returns error state as received from SQL Server- Specified by:
getErrorStatein interfaceISQLServerMessage- Returns:
- Error State
-
getErrorSeverity
public int getErrorSeverity()
Returns Severity of error (as int value) as received from SQL Server- Specified by:
getErrorSeverityin interfaceISQLServerMessage- Returns:
- Error Severity
-
getServerName
public String getServerName()
Returns name of the server where exception occurs as received from SQL Server- Specified by:
getServerNamein interfaceISQLServerMessage- Returns:
- Server Name
-
getProcedureName
public String getProcedureName()
Returns name of the stored procedure where exception occurs as received from SQL Server- Specified by:
getProcedureNamein interfaceISQLServerMessage- Returns:
- Procedure Name
-
getLineNumber
public long getLineNumber()
Returns line number where the error occurred in Stored Procedure returned bygetProcedureName()as received from SQL Server- Specified by:
getLineNumberin interfaceISQLServerMessage- Returns:
- Line Number
-
getSQLServerMessage
public SQLServerError getSQLServerMessage()
Description copied from interface:ISQLServerMessageReturns SQLServerError containing detailed info about SQL Server Message as received from SQL Server.- Specified by:
getSQLServerMessagein interfaceISQLServerMessage- Returns:
- SQLServerError
-
toSQLServerInfoMessage
public ISQLServerMessage toSQLServerInfoMessage()
Downgrade a Error message into a Info messageThis simply create a SQLServerInfoMessage from this SQLServerError, without changing the message content.
- Returns:
- ISQLServerMessage
-
toSQLServerInfoMessage
public ISQLServerMessage toSQLServerInfoMessage(int newErrorSeverity)
Downgrade a Error message into a Info messageThis simply create a SQLServerInfoMessage from this SQLServerError,
- Parameters:
newErrorSeverity- - The new ErrorSeverity- Returns:
- ISQLServerMessage
-
toSQLServerInfoMessage
public ISQLServerMessage toSQLServerInfoMessage(int newErrorSeverity, int newErrorNumber)
Downgrade a Error message into a Info messageThis simply create a SQLServerInfoMessage from this SQLServerError,
- Parameters:
newErrorSeverity- - If you want to change the ErrorSeverity (-1: leave unchanged)newErrorNumber- - If you want to change the ErrorNumber (-1: leave unchanged)- Returns:
- ISQLServerMessage
-
setErrorSeverity
public void setErrorSeverity(int newSeverity)
Set a new ErrorSeverity for this Message- Parameters:
newSeverity- new severity
-
setErrorNumber
public void setErrorNumber(int newErrorNumber)
Set a new ErrorNumber for this Message- Parameters:
newErrorNumber- new error number
-
toSqlExceptionOrSqlWarning
public SQLException toSqlExceptionOrSqlWarning()
Description copied from interface:ISQLServerMessageCreates a SQLServerException or SQLServerWarning from this SQLServerMessage- Specified by:
toSqlExceptionOrSqlWarningin interfaceISQLServerMessage- Returns:
- SQLServerException if it's a SQLServerError object
- SQLServerWarning if it's a SQLServerInfoMessage object
-
-