Interface ISqlRunner

All Superinterfaces:
IDisposable, IEntity

public interface ISqlRunner extends IEntity
Contains methods to perform SQL operations on the Altitude uCI Server database.
  • Method Details

    • getCursor

      ISqlCursor getCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a SQL cursor.
      Parameters:
      cursorId - Identifier of the cursor.
      Returns:
      The ISqlCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getInstance

      IInstance getInstance() throws Exception, altitude.integrationServer.exceptions.ISException
      The instance that created the SQL Runner.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • getSqlCursors

      ISqlCursor[] getSqlCursors() throws Exception, altitude.integrationServer.exceptions.ISException
      The existing SQL cursors.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
    • newSqlCursor

      ISqlCursor newSqlCursor(String statement) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Creates a new cursor.
      Parameters:
      statement - Sql statement to execute on the Altitude uCI Server.
      Returns:
      The created cursor object.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException
    • sqlExecute

      int sqlExecute(String statement) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Executes an SQL statement on the Altitude uCI Server as a transaction and returns the serial number, when supplied by the SQL DBMS.
      Parameters:
      statement - Sql statement to execute on the Altitude uCI Server.
      Returns:
      Serial number when supplied by the SQL DBMS.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException
    • sqlSelect

      String[] sqlSelect(String statement) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Executes the SQL select statement on the Altitude uCI Server and returns an array with the resulting strings.
      Parameters:
      statement - SQL statement to execute on the Altitude uCI Server.
      Returns:
      An array with the resulting strings.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException
    • tryGetCursor

      ISqlCursor tryGetCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a SQL cursor or null if it doesn't exist.
      Parameters:
      cursorId - Identifier of the cursor.
      Returns:
      The ISqlCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException