Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%Library] >  [GTWResultSet]
Private  Storage   

class %Library.GTWResultSet extends %Library.IResultSet, %IProcedureContext

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
7 11


Summary

Properties
%CurrentResult %Message %Metadata %OutputColumnCount
%PrivateTables %ROWCOUNT %ROWID %ResultColumnCount
%SQLCODE %StatementType %StatementTypeName Data
Error bRClose colindex columns
firsttime gwc hstmt

Methods
%ClassIsLatestVersion %ClassName %CloseCursor %ConstructClone
%CreateSnapshot %DispatchClassMethod %DispatchGetModified %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %Display %DisplayFormatted
%Extends %Get %GetData %GetMetadata
%GetParameter %IsA %IsModified %MoreResults
%New %Next %NextOutputValue %NextResult
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%Prepare %PrepareMetaData %Print %SendODBC
%SerializeObject %SetModified %ValidateObject CloseCurrentResult
CreateStaticRS NextResult


Properties

• property Data  [ MultiDimensional ];
• property bRClose as %Boolean;
• property colindex  [ MultiDimensional ];
• property columns  [ MultiDimensional ];
• property firsttime as %Integer;
• property gwc as %SQLGatewayConnection;
• property hstmt as %String;

Methods

• method %CloseCursor() as %Status
This method is expected to be overridden by concrete subclasses
• method %Get(colname As %String = "") as %Library.String
Returns the value of the column with the name pColumnName in the current row of the result set.

If pColumnName is not a valid column name, this method returns an empty string.

• method %GetData(colnbr As %Integer) as %Library.String
Returns the value of column pColumnNumber in the current row of the result set.
• method %Next(ByRef sc As %Library.Status) as %Library.Integer
Advance the procedural result set cursor to the next row. Returns 0 if the cursor is at the end of the result set or if an error was encountered. Errors are reported in dynamic SQL using the %SQLCODE and %Message properties of the statement result. An optional argument will contain a %Status value on return. This %Status value indicates success or failure of the %Next call but it should be considered to be a secondary error reporting interface, %SQLCODE being the primary error reporting mechanism. This implementation can be overridden by classes that implement the procedural cursor interface.
• method %Print() as %Status
Print the contents of the current row on the current device.
• method %SendODBC() as %Integer
Fetch and send a series of rows for the ODBC/JDBC server. For internal use only.
• method CreateStaticRS(ByRef sqcon As %Library.ObjectHandle) as %Library.Status
• method NextResult() as %Library.RegisteredObject
Called to return the next resultset object. This also removes the reference to the existing object so it can cleanup and close itself


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.