%DeepSee.SetBuilder.ResultSet
hidden abstract class %DeepSee.SetBuilder.ResultSet extends %SQL.CustomResultSet
Method Inventory
Methods
abstract method %ClearRowData() as %Status
Implementation generated by subclass
method %Get(colname As %String = "") as %Library.String
Inherited description: Returns the value of the column with the name colname in the current row of the result set.
If colname is not a valid column name, this method throws a error.
method %GetData(colnbr As %Integer = 0) as %Library.String
Inherited description: %GetData()
Returns the value of the column referenced by colnbr. Object values are not swizzled automatically.
method %GetMetadata() as %SQL.StatementMetadata
Return the result set metadata as a %SQL.StatementMetadata instance.
abstract method %LoadRowData() as %Status
Implementation generated by subclass
method %Next(ByRef sc As %Library.Status = $$$OK) as %Library.Integer
Inherited description: Advance to the next row in the result referenced by %ProcCursor. Returns 0 if the cursor is at the end of the
result set. An optional argument contains a %Library.Status value on return. This %Status value
indicates success or failure of the %Next call. %SQLCODE is also set by %Next.
This implementation is overridden by classes that implement the result set interface.
method %OpenCursor() as %Library.Status
Inherited description: Implement code to open the cursor here. You may also define new formal arguments. Any arguments defined
will be automatically added to the constructor interface and callers can specify actual arguments in the
call to %New().
method %OpenCursor(pBeginDate as %Date = "", pEndDate as %Date = "") as %Library.Status [ private ] { set ..BeginDate = pBeginDate set ..EndDate = $Select(pEndDate'="":pEndDate,1:$H) quit $$$OK }Given the above example implementation of %OpenCursor, the following is a valid call to instantiate a new instance.
set tResult = ##class(MyCustom.ResultSet).%New(,$H-30,$H-10)To report an error from %OpenCursor just set ..%SQLCODE and %Message to appropriate values. To report no rows found, set %SQLCODE to 100. Errors are indicated by negative ..%SQLCODE values.
Inherited Members
Inherited Properties
- %CurrentResult
- %Message
- %Metadata
- %OutputColumnCount
- %PrivateTables
- %ROWCOUNT
- %ROWID
- %ResultColumnCount
- %SQLCODE
- %StatementType
- %StatementTypeName
Inherited Methods
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %Display()
- %DisplayFormatted()
- %Extends()
- %GetParameter()
- %GetSerializedMetadata()
- %IsA()
- %IsModified()
- %MoreResults()
- %New()
- %NextOutputValue()
- %NextResult()
- %NormalizeObject()
- %ObjectModified()
- %OnNew()
- %OriginalNamespace()
- %PackageName()
- %Print()
- %SendODBC()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- Close()
- Fetch()
- FetchRows()
- GetInfo()
- GetODBCInfo()
- getSelectMode()