Skip to main content

%ResultSet.Static

Class %ResultSet.Static Extends %Library.IResultSet [ System = 4 ]

A Static result set is one where the original data source (a result set object) is copied to a process private global upon instantiation. Future data requests then use that snapshot instead of the original data.

Properties

%storageOffset

Property %storageOffset As %Integer [ Private ];

%currentRow

Property %currentRow As %Integer [ Private ];

%columnCount

Property %columnCount As %Integer [ Private ];

%Data

Property %Data As %String(MAXLEN = "") [ MultiDimensional, Private ];

%Data is a multidimensional property of column values for the current row. It is subscripted by column number.

%hasStreams

Property %hasStreams As %Integer [ InitialExpression = 0, Private ];

%streams

Property %streams As %String [ Internal, MultiDimensional ];

%streamColumns

Property %streamColumns As %String(MAXLEN = "") [ Internal ];

%lastRow

Property %lastRow As %Integer [ Private ];

Methods

%ROWCOUNTGet

Method %ROWCOUNTGet() As %Integer [ CodeMode = expression ]

%RowCount for a static result set is always the number of rows in the static set.

%OnNew

Method %OnNew(initvalue As %RawString, pRuntimeMode As %Integer = {$zu(115,5)}) As %Status [ Private, ProcedureBlock = 1, PublicList = SQLCODE, ServerOnly = 1 ]

%OnClose

Method %OnClose() As %Status [ Private ]

%SendRows

Method %SendRows() As %Integer

%SendODBC

Method %SendODBC() As %Library.Integer

Fetch and send a series of rows for the ODBC/JDBC server. For internal use only.

%Next

Method %Next(ByRef sc As %Library.Status = {$$$OK}) As %Library.Integer

Advance the result set cursor to the next row. Returns 0 if the cursor is at the end of the result set. The global structure consists of a base $list with individual nodes for columns. The base $list() can contain zero or more column values. Additional column values are stored in the global subscripted by column number and equal to the column value.

%Get

Method %Get(colname As %String = "") As %Library.String

Returns the value of the column with the name name in the current row of the result set.

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

%GetData

Method %GetData(colnbr As %Integer = 0) As %Library.String

Returns the value of column colnbr in the current row of the result set.

%SetIterator

Method %SetIterator(pRowNumber As %Library.Integer = 0) As %Library.Integer