This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions page (login required).


class %Compiler.LG.QueryHelper extends %Library.RegisteredObject, %Collection.AbstractListOfObj

Property Inventory (Including Private)

Method Inventory (Including Private)


property Class as %String [ Private ];
Property methods: ClassDisplayToLogical(), ClassGet(), ClassIsValid(), ClassLogicalToDisplay(), ClassLogicalToOdbc(), ClassNormalize(), ClassSet()
property Count as %Integer [ Private ];
Property methods: Count(), CountDisplayToLogical(), CountGet(), CountIsValid(), CountLogicalToDisplay(), CountNormalize(), CountSet()
property Cursor as %Integer [ Private ];
Property methods: CursorDisplayToLogical(), CursorGet(), CursorIsValid(), CursorLogicalToDisplay(), CursorNormalize(), CursorSet()
property RS as %Library.ScrollableResultSet [ Private ];
Property methods: RSGet(), RSGetSwizzled(), RSIsValid(), RSNewObject(), RSSet()


method Count() as %Integer
Returns the number of elements contained in the list.
method GetAt(key As %Integer = 0) as %RegisteredObject
Finds and returns the value of the element at position key in the list.

GetAt returns the value of the element at location key or null string ("") if no element is found.

method GetNext(ByRef key As %Integer) as %RegisteredObject
Finds and returns the value of the element at the position after key in the list. If key is a null string (""), it returns the value of the first element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the end of the list.

method Init(class As %String, sql As %String, args) as %Status
classmethod Query(class As %String, sql As %String, args) as QueryHelper

Inherited Members

Inherited Methods (Including Private)