%Collection.AbstractListOfObj

class %Collection.AbstractListOfObj extends %Collection.AbstractList

A list collection represents a list of data type elements, each of which is associated with a numeric position in the list. The first element in the list is stored at position 1.

The %Collection.AbstractList class provides the basic functionality of the various list collection classes.

The non-abstract list classes derived from %AbstractList include %ListOfDataTypes, %ListOfObjects, %Collection.ListOfObj and %Collection.ListOfDT. You can use a list object as follows:

  Set list=##class(%ListOfDataTypes).%New()
  
  ; add items to the list
  Do list.Insert("Harpo")
  Do list.Insert("Groucho")
  Do list.Insert("Chico")
  Do list.Insert("Karl")
  
  ; iterate over contents of list
  For i=1:1:list.Count()  Write list.GetAt(i),!

Method Inventory

Methods

abstract method Find(element As %ObjectIdentity, key As %Integer) as %String

Starting from, but not including, position key, Find finds the next element in the list with value equal to element. If key is a null string, Find starts at the beginning of the list.

Find returns the position of the found element or null string ("") if no element was found.

abstract method FindObjectId(id As %String, key As %Integer) as %String

Starting from, but not including, position key, FindObjectId finds the next element in the list whose ObjectId equals id. If key is a null string, Find starts at the beginning of the list.

Find returns the position of the found element or null string ("") if no element was found.

abstract method FindOref(oref As %RegisteredObject, key As %Integer = "", id As %String = "") as %String

Starting from, but not including, location key, finds the next element in the array whose Oref value equals oref.

If key is a null string (""), the search starts at the beginning of the array.

FindOref returns the key associated with the found element or null string ("") if no element is found. Unswizzled references are compared to oref.%Oid() and if equal, swizzling will occur.

abstract 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.

abstract 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.

abstract method GetObjectAt(key As %Integer, force As %Integer = 0) as %ObjectIdentity

Finds and returns the OID value referring to the object at position key in the list.

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

abstract method GetObjectIdAt(key As %Integer, force As %Integer = 0) as %String

Finds and returns the ID value referring to the object at position key in the list.

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

abstract method GetObjectIdNext(ByRef key As %Integer) as %String

Finds and returns the ID value referring to the object at the position after key in the list. If key is a null string (""), it returns the ID 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.

abstract method GetObjectIdPrevious(ByRef key As %Integer) as %String

Finds and returns the ID value referring to the object at the position before key in the list. If key is a null string (""), it returns the ID value of the last 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 beginning of the list.

abstract method GetObjectNext(ByRef key As %Integer) as %ObjectIdentity

Finds and returns the OID value referring to the object at the position after key in the list. If key is a null string (""), it returns the OID 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.

abstract method GetObjectPrevious(ByRef key As %Integer) as %ObjectIdentity

Finds and returns the OID value referring to the object at the position before key in the list. If key is a null string (""), it returns the OID value of the last 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 beginning of the list.

abstract method GetPrevious(ByRef key As %Integer) as %RegisteredObject

Finds and returns the value of the element at the position before key in the list. If key is a null string (""), it returns the value of the last 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 beginning of the list.

abstract method Insert(element As %RegisteredObject) as %Status

Inserts an element with value element at the end of the list.