Starting from, but not including, location key,
finds the next element in the array with value equal to 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.
abstract 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.
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.
Finds and returns the value of the element at the location after key
in the array. If key is a null string (""), it returns
the 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.
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.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract 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.
abstract method GetPrevious(ByRef key As %String) as %RegisteredObject [ Language = objectscript ]
Finds and returns the value of the element at the location before key
in the array. If key is a null string (""), it returns
the 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.
Removes the element associated with key in the array.
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.
