%Collection.ListOfObj
class %Collection.ListOfObj extends %Collection.AbstractListOfObj, %Collection.Super
For information on this class, see Working with Collections.
The %Collection.ListOfObj class represents a list of references to objects, each of which is associated with a numeric position in the list. The first element in the list is stored at position 1. The objects referred to must be registered. They can be either persistent objects or non-id objects.Internally, a %Collection.ListOfObj object contains two lists: one for holding the OID values for the objects referred to (or their serialized state in the case of a list 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 list. For example, if list is an %Collection.ListOfObj object containing a list of Doctor objects (that is a list of OID values for Doctor objects stored in the database) then the following code fragment will automatically load the Doctor object at location 7 in the list 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=list.GetAt(7) Write doc.Name
Set name=list.GetAt(7).Name
Property Inventory
Method Inventory
- %UnSwizzleAt()
- Count()
- DeSerialize()
- Find()
- FindObjectId()
- FindOref()
- GetAt()
- GetNext()
- GetObjectAt()
- GetObjectIdAt()
- GetObjectIdNext()
- GetObjectIdPrevious()
- GetObjectNext()
- GetObjectPrevious()
- GetPrevious()
- Insert()
- InsertAt()
- InsertObject()
- InsertObjectAt()
- InsertObjectId()
- InsertObjectIdAt()
- IsDefined()
- Next()
- Previous()
- RemoveAt()
- Serialize()
- SetAt()
- SetObjectAt()
- SetObjectIdAt()
- SizeGet()
- SizeSet()
Parameters
Properties
Methods
Returns a %Status value indicating success or failure.
Find returns the position of the found element or null string ("") if no element was 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 value of the element at location key or null string ("") if no element is found.
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.
Returns the value of the element at location key or null string ("") if no element is found.
Returns the value of the element at location key or null string ("") if no element is found.
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.
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.
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.
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.
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.
Returns a %Status value indicating success or failure.
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.Returns a %Status value indicating success or failure.
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.Returns a %Status value indicating success or failure.
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.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()
- InsertList()
- InsertOrdered()
- LogicalToOdbc()
- OdbcToLogical()