com.microsoft.sqlserver.jdbc.ISQLServerMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mssql-jdbc Show documentation
Microsoft JDBC Driver for SQL Server.
The newest version!
/*
 * Microsoft JDBC Driver for SQL Server Copyright(c) Microsoft Corporation All rights reserved. This program is made
 * available under the terms of the MIT License. See the LICENSE file in the project root for more information.
 */
package com.microsoft.sqlserver.jdbc;

import java.sql.SQLException;


/**
 * Provides an interface SQLServerMessage
 */
public interface ISQLServerMessage {
    /**
     * Returns SQLServerError containing detailed info about SQL Server Message as received from SQL Server.
     * 
     * @return SQLServerError
     */
    public SQLServerError getSQLServerMessage();

    /**
     * Returns error message as received from SQL Server
     * 
     * @return Error Message
     */
    public String getErrorMessage();

    /**
     * Returns error number as received from SQL Server
     * 
     * @return Error Number
     */
    public int getErrorNumber();

    /**
     * Returns error state as received from SQL Server
     * 
     * @return Error State
     */
    public int getErrorState();

    /**
     * Returns Severity of error (as int value) as received from SQL Server
     * 
     * @return Error Severity
     */
    public int getErrorSeverity();

    /**
     * Returns name of the server where exception occurs as received from SQL Server
     * 
     * @return Server Name
     */
    public String getServerName();

    /**
     * Returns name of the stored procedure where exception occurs as received from SQL Server
     * 
     * @return Procedure Name
     */
    public String getProcedureName();

    /**
     * Returns line number where the error occurred in Stored Procedure returned by getProcedureName() as
     * received from SQL Server
     * 
     * @return Line Number
     */
    public long getLineNumber();

    /**
     * Creates a SQLServerException or SQLServerWarning from this SQLServerMessage

     * 
     * @return
     *         
     *         SQLServerException if it's a SQLServerError object
     *         SQLServerWarning if it's a SQLServerInfoMessage object
     *         
     */
    public SQLException toSqlExceptionOrSqlWarning();

    /**
     * Check if this is a isErrorMessage
     * 
     * @return true if it's an instance of SQLServerError
     */
    public default boolean isErrorMessage() {
        return this instanceof SQLServerError;
    }

    /**
     * Check if this is a SQLServerInfoMessage
     * 
     * @return true if it's an instance of SQLServerInfoMessage
     */
    public default boolean isInfoMessage() {
        return this instanceof SQLServerInfoMessage;
    }
}