Home > Class Reference > %SYS namespace > %Collection.AbstractIterator
Private  Storage   

%Collection.AbstractIterator


abstract class %Collection.AbstractIterator

Definition of iterator methods that all our collections classes use to ensure consistency.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3


Summary


Methods
GetAt GetNext Next

Subclasses
%Collection.AbstractArray %Collection.AbstractList %Library.RelationshipObject
%Net.LDAP.Client.Entries %Net.LDAP.Client.Entry %Net.LDAP.Client.ValueList

Methods


• abstract method GetAt(key As %RawString = "") as %RawString
Finds and returns the value of the element associated with key.

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

• abstract method GetNext(ByRef key As %RawString) as %RawString
Finds and returns the value of the element at the location after key in the iteration. If key is a null string (""), it returns the value of the first element in the array.

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

• abstract method Next(key As %RawString = "") as %RawString
Finds and returns the key value of the element at the location following key in the iteration. If key is a null string (""), then Next returns the key value for the first element in the array.