Class %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.ListOfObjects 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),!

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		22

Summary

Methods
Clear	Count	Find	FindObjectId
FindOref	GetAt	GetNext	GetObjectAt
GetObjectIdAt	GetObjectIdNext	GetObjectIdPrevious	GetObjectNext
GetObjectPrevious	GetPrevious	Insert	InsertAt
InsertList	InsertObject	InsertObjectAt	InsertObjectId
InsertObjectIdAt	InsertOrdered	Next	Previous
RemoveAt	SetAt	SetObjectAt	SetObjectIdAt

Subclasses
%Collection.ListOfObj	%Compiler.LG.QueryHelper	%Library.ListOfObjects

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.
Returns a %Status value indicating success or failure.

• abstract method InsertAt(element As %RegisteredObject, key As %Integer) as %Status

Inserts an element with value element at position key.
To make room for the new element, the elements previously at or following position key are moved up by one position.
key must be in the following range:
1 <= key <= Count() + 1
Returns a %Status value indicating success or failure.

• abstract method InsertObject(oid As %ObjectIdentity) as %Status

Inserts an element with OID value oid at the end of the list.
Returns a %Status value indicating success or failure.

• abstract method InsertObjectAt(oid As %ObjectIdentity, key As %Integer) as %Status

Inserts an element with OID value oid at position key.
To make room for the new element, the elements previously at or following position key are moved up by one position.
key must be in the following range:
1 <= index <= Count() + 1
Returns a %Status value indicating success or failure.

• abstract method InsertObjectId(id As %String) as %Status

Inserts an element with ID value id at the end of the list.
Returns a %Status value indicating success or failure.

• abstract method InsertObjectIdAt(id As %String, key As %Integer) as %Status

Inserts an element with ID value id at position key.
To make room for the new element, the elements previously at or following position key are moved up by one position.
key must be in the following range:
1 <= index <= Count() + 1
Returns a %Status value indicating success or failure.

• abstract method RemoveAt(key As %Integer, Output success As %Boolean) as %ObjectIdentity

Removes the element at position key in the list. The elements following position key are moved to fill in the resulting gap.
RemoveAt returns the value of the removed element or null string ("") if no element was removed. It also has a success output argument that returns true if the item was removed and false if it was not.

• abstract method SetAt(element As %RegisteredObject, key As %Integer) as %Status

Sets the value of the element at position key to element.
Returns a %Status value indicating success or failure.

• abstract method SetObjectAt(oid As %ObjectIdentity, key As %Integer) as %Status

Sets the OID value of the element at position key to oid.
Returns a %Status value indicating success or failure.

• abstract method SetObjectIdAt(id As %String, key As %Integer) as %Status

Sets the ID value of the element at position key to id.
Returns a %Status value indicating success or failure.


[BASEXML] > [%Collection] > [AbstractListOfObj]		Private Storage