Home > Class Reference > %SYS namespace > %Collection.ArrayOfObj

%Collection.ArrayOfObj

class %Collection.ArrayOfObj extends %Collection.AbstractArrayOfObj, %Collection.Super

The %Collection.ArrayOfObjects class represents an array of references to objects, each of which is associated with a unique key value. Keys can have any value, string or numeric. The objects referred to must be registered. They can be either persistent objects or non-id objects.

Internally, an %Collection.ArrayOfObjects object contains two arrays: one for holding the OID values for the objects referred to (or their serialized state in the case of an array of non-id objects); and another for holding the OREF values for any objects that have been explicitly referred to, and hence "swizzled" into memory. Swizzling (loading an object into memory and generating an OREF value for it) happens automatically whenever the user refers to an object within the array.

For example, if array is an %Collection.ArrayOfObjects object containing an array of Doctor objects (that is an array of OID values for Doctor objects stored in the database) then the following code fragment will automatically load the Doctor object associated with the key "Primary" into memory and generate an OREF value referring to the in-memory version of the Doctor object. This OREF value can then be used to access the properties and methods of the Doctor object:

  Set doc=array.GetAt("Primary")
  Write doc.Name
  

Alternatively, we could use cascading dot syntax:

  Set name=array.GetAt("Primary").Name
  
These %Collection classes can only be used when you have a collection property of another object as they rely on storing the data inside the parent object, they can not be used as 'stand alone' collections, for this use the %ArrayOfObjects.

Method Inventory

Parameters

parameter IdCollection = 0;
If true then in the container we have an array of id's rather than an array of oid's

Methods

method %UnSwizzleAt(key As %String, force As %Integer = 0) as %Status [ Language = objectscript ]
Unswizzles (removes from memory) the element associated with key in the array.

Returns a %Status value indicating success or failure.

method Count() as %Integer [ Language = objectscript ]
Returns the number of elements contained in the array.
method DeSerialize(serialized As %String(MAXLEN="")) as %Status [ Language = objectscript ]
Inherited description: Deserialize from string created with Serialize() back to collection
final method Define(key As %String) as %Boolean [ Language = objectscript ]
Inherited description: This method is deprecated.

Please use IsDefined() instead.

method Find(element As %ObjectIdentity, key As %String) as %String [ Language = objectscript ]
Starting from, but not including, location key, finds the next element in the array whose OID value equals element.

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

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

method FindObjectId(id As %String, key As %Integer) as %String [ Language = objectscript ]
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.

method FindOref(oref As %RegisteredObject, key As %String = "", id As %String = "") as %String [ Language = objectscript ]
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.

method GetAt(key As %String) as %RegisteredObject [ Language = objectscript ]
Finds and returns the OREF value of the element associated with key.

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

method GetNext(ByRef key As %String) as %RegisteredObject [ Language = objectscript ]
Finds and returns the OREF value of the element at the location after key in the array. If key is a null string (""), it returns the OREF 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.

method GetObjectAt(key As %String, force As %Integer = 0) as %ObjectIdentity [ Language = objectscript ]
Finds and returns the OID value of the element associated with key.

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

method GetObjectIdAt(key As %String, force As %Integer = 0) as %String [ Language = objectscript ]
Finds and returns the ID value of the element associated with key.

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

method GetObjectIdNext(ByRef key As %String) as %String [ Language = objectscript ]
Finds and returns the ID value of the element at the location after key in the array. If key is a null string (""), it returns the ID 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.

method GetObjectIdPrevious(ByRef key As %String) as %String [ Language = objectscript ]
Finds and returns the ID value of the element at the location before key in the array. If key is a null string (""), it returns the ID value of the last 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 beginning of the array.

method GetObjectNext(ByRef key As %String) as %ObjectIdentity [ Language = objectscript ]
Finds and returns the OID value of the element at the location after key in the array. If key is a null string (""), it returns the OID 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.

method GetObjectPrevious(ByRef key As %String) as %ObjectIdentity [ Language = objectscript ]
Finds and returns the OID value of the element at the location before key in the array. If key is a null string (""), it returns the OID value of the last 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 beginning of the array.

method GetPrevious(ByRef key As %String) as %RegisteredObject [ Language = objectscript ]
Finds and returns the OREF value of the element at the location before key in the array. If key is a null string (""), it returns the OREF value of the last 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 beginning of the array.

final method IsDefined(key As %String) as %Boolean [ Language = objectscript ]
Inherited description: Returns true (1) if a value is defined at location key, otherwise false (0).
final method Next(key As %String = "") as %String [ Language = objectscript ]
Inherited description: 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.
final method Previous(key As %String = "") as %String [ Language = objectscript ]
Inherited description: Finds and returns the key value of the element at the location preceding key in the array. If key is a null string (""), then Previous() returns the key value for the last element in the array.
method RemoveAt(key As %String, Output success As %Boolean) as %ObjectIdentity [ Language = objectscript ]
Removes the element associated with key in the array.

RemoveAt returns the OID 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.

method Serialize(force As %Integer = 0) as %String [ Language = objectscript ]
Serialize() constructs a serialized form of the collection as a string
method SetAt(oref As %RegisteredObject, key As %String) as %Status [ Language = objectscript ]
Sets the OREF value of the element associated with key to element.

Returns a %Status value indicating success or failure.

method SetObjectAt(oid As %ObjectIdentity, key As %String) as %Status [ Language = objectscript ]
Sets the OID value of the element associated with key to element.

Returns a %Status value indicating success or failure.

method SetObjectIdAt(id As %String, key As %String) as %Status [ Language = objectscript ]
Sets the ID value of the element associated with key to element.

Returns a %Status value indicating success or failure.

Inherited Methods

Subclasses