%ResultSet.Static
class %ResultSet.Static extends %Library.IResultSet
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.Property Inventory (Including Private)
Method Inventory (Including Private)
Properties
property %Data as %String) [ Private , MultiDimensional ];
%Data is a multidimensional property of column values for the current row. It is subscripted by column
number.
Property methods: %DataDisplayToLogical(), %DataGet(), %DataIsValid(), %DataLogicalToDisplay(), %DataLogicalToOdbc(), %DataNormalize(), %DataSet()
property %columnCount as %Integer [ Private ];
Property methods: %columnCountDisplayToLogical(), %columnCountGet(), %columnCountIsValid(), %columnCountLogicalToDisplay(), %columnCountNormalize(), %columnCountSet()
property %currentRow as %Integer [ Private ];
Property methods: %currentRowDisplayToLogical(), %currentRowGet(), %currentRowIsValid(), %currentRowLogicalToDisplay(), %currentRowNormalize(), %currentRowSet()
property %hasStreams as %Integer [ Private , InitialExpression = 0 ];
Property methods: %hasStreamsDisplayToLogical(), %hasStreamsGet(), %hasStreamsIsValid(), %hasStreamsLogicalToDisplay(), %hasStreamsNormalize(), %hasStreamsSet()
property %lastRow as %Integer [ Private ];
Property methods: %lastRowDisplayToLogical(), %lastRowGet(), %lastRowIsValid(), %lastRowLogicalToDisplay(), %lastRowNormalize(), %lastRowSet()
property %storageOffset as %Integer [ Private ];
Property methods: %storageOffsetDisplayToLogical(), %storageOffsetGet(), %storageOffsetIsValid(), %storageOffsetLogicalToDisplay(), %storageOffsetNormalize(), %storageOffsetSet()
Methods
method %Get(colname As %String = "") as %Library.String [ Language = objectscript ]
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.
method %GetData(colnbr As %Integer = 0) as %Library.String [ Language = objectscript ]
Returns the value of column colnbr in the current row of the result set.
method %Next(ByRef sc As %Library.Status = $$$OK) as %Library.Integer [ Language = objectscript ]
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.
private method %OnClose() as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %Close() method to
provide notification that the current object is being closed.
The return value of this method is ignored.
private method %OnNew(initvalue As %RawString, pRuntimeMode As %Integer = {$zu(115, 5)}) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %New() method to
provide notification that a new instance of an object is being created.
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.
method %ROWCOUNTGet() as %Integer [ Language = objectscript ]
%RowCount for a static result set is always the number of rows in the static set.
method %SendODBC() as %Library.Integer [ Language = objectscript ]
Fetch and send a series of rows for the ODBC/JDBC server. For internal use only.
method %SendRows() as %Integer [ Language = objectscript ]
method %SetIterator(pRowNumber As %Library.Integer = 0) as %Library.Integer [ Language = objectscript ]
Inherited Members
Inherited Properties (Including Private)
- %Message
- %Metadata
- %NextColumn
- %PrivateTables
- %ROWCOUNT
- %ROWID
- %ResultColumnCount
- %RuntimeMode
- %SQLCODE
Inherited Methods (Including Private)
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %CloseCursor()
- %ConstructClone()
- %ConstructCloneInit()
- %CreateSnapshot()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %Display()
- %DisplayFormatted()
- %Extends()
- %GetMetadata()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToSaveSet()
- %OnConstructClone()
- %OnValidateObject()
- %OriginalNamespace()
- %PackageName()
- %Prepare()
- %PrepareMetaData()
- %Print()
- %RemoveFromSaveSet()
- %ResultColumnCountGet()
- %SendDelimitedRows()
- %SerializeObject()
- %SetModified()
- %ValidateObject()