Share via

SQLServerError Class

Package:
com.microsoft.sqlserver.jdbc
Maven Artifact:
com.microsoft.sqlserver:mssql-jdbc:12.8.0.jre11
  • java.lang.Object
    • com.microsoft.sqlserver.jdbc.StreamPacket
      • com.microsoft.sqlserver.jdbc.SQLServerError

Implements

ISQLServerMessage java.io.Serializable

public final class SQLServerError
extends com.microsoft.sqlserver.jdbc.StreamPacket
implements java.io.Serializable, ISQLServerMessage

SQLServerError represents a TDS error or message event.

Method Summary

Modifier and Type Method and Description
java.lang.String getErrorMessage()

Returns error message as received from SQL Server
int getErrorNumber()

Returns error number as received from SQL Server
int getErrorSeverity()

Returns Severity of error (as int value) as received from SQL Server
int getErrorState()

Returns error state as received from SQL Server
long getLineNumber()

Returns line number where the error occurred in Stored Procedure returned by getProcedureName() as received from SQL Server
java.lang.String getProcedureName()

Returns name of the stored procedure where exception occurs as received from SQL Server
SQLServerError getSQLServerMessage()

Returns SQLServerError containing detailed info about SQL Server Message as received from SQL Server.
java.lang.String getServerName()

Returns name of the server where exception occurs as received from SQL Server
void setErrorNumber(int newErrorNumber)

Set a new ErrorNumber for this Message
void setErrorSeverity(int newSeverity)

Set a new ErrorSeverity for this Message
ISQLServerMessage toSQLServerInfoMessage()

Downgrade a Error message into a Info message
ISQLServerMessage toSQLServerInfoMessage(int newErrorSeverity)

Downgrade a Error message into a Info message
ISQLServerMessage toSQLServerInfoMessage(int newErrorSeverity, int newErrorNumber)

Downgrade a Error message into a Info message
java.sql.SQLException toSqlExceptionOrSqlWarning()

Creates a SQLServerException or SQLServerWarning from this SQLServerMessage

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

getErrorMessage

public String getErrorMessage()

Returns error message as received from SQL Server

Returns:

Error Message

getErrorNumber

public int getErrorNumber()

Returns error number as received from SQL Server

Returns:

Error Number

getErrorSeverity

public int getErrorSeverity()

Returns Severity of error (as int value) as received from SQL Server

Returns:

Error Severity

getErrorState

public int getErrorState()

Returns error state as received from SQL Server

Returns:

Error State

getLineNumber

public long getLineNumber()

Returns line number where the error occurred in Stored Procedure returned by getProcedureName() as received from SQL Server

Returns:

Line Number

getProcedureName

public String getProcedureName()

Returns name of the stored procedure where exception occurs as received from SQL Server

Returns:

Procedure Name

getSQLServerMessage

public SQLServerError getSQLServerMessage()

Returns SQLServerError containing detailed info about SQL Server Message as received from SQL Server.

getServerName

public String getServerName()

Returns name of the server where exception occurs as received from SQL Server

Returns:

Server Name

setErrorNumber

public void setErrorNumber(int newErrorNumber)

Set a new ErrorNumber for this Message

Parameters:

newErrorNumber - new error number

setErrorSeverity

public void setErrorSeverity(int newSeverity)

Set a new ErrorSeverity for this Message

Parameters:

newSeverity - new severity

toSQLServerInfoMessage

public ISQLServerMessage toSQLServerInfoMessage()

Downgrade a Error message into a Info message

This 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 message

This 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 message

This 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

toSqlExceptionOrSqlWarning

public SQLException toSqlExceptionOrSqlWarning()

Creates a SQLServerException or SQLServerWarning from this SQLServerMessage

Applies to