%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
Method Inventory
- %UnSwizzleAt()
- Count()
- DeSerialize()
- Define()
- Find()
- FindObjectId()
- FindOref()
- GetAt()
- GetNext()
- GetObjectAt()
- GetObjectIdAt()
- GetObjectIdNext()
- GetObjectIdPrevious()
- GetObjectNext()
- GetObjectPrevious()
- GetPrevious()
- IsDefined()
- Next()
- Previous()
- RemoveAt()
- Serialize()
- SetAt()
- SetObjectAt()
- SetObjectIdAt()
Parameters
Methods
Returns a %Status value indicating success or failure.
Please use IsDefined() instead.
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.
Find returns the position of the found element or null string ("") if no element was found.
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.
GetAt returns the OREF value of the element associated with key or null string ("") if no element is found.
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.
GetObjectAt returns the OID value of the element associated with key or null string ("") if no element is found.
GetObjectIdAt returns the ID value of the element associated with key or null string ("") if no element is found.
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.
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.
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.
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.
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.
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.
Returns a %Status value indicating success or failure.
Returns a %Status value indicating success or failure.
Returns a %Status value indicating success or failure.
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %Disconnect()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %IsNull()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- BuildValueArray()
- Clear()
- LogicalToOdbc()
- OdbcToLogical()