Registered relationship class for relationship cardinalities many and children.
Instances of this class are used by n-cardinality relationships to manage objects
currently related to the container object and also to manage the objects whose
relationship with the container object has been removed. Related objects are loaded
into this object using a query-like interface that is implemented by the inverse
relationship. The order in which related objects are loaded is neither guaranteed or
maintained as objects are related or unrelated.
This class is used internally by InterSystems IRIS. You should not make direct
use of it within your applications. There is no guarantee made about either
the behavior or future operation of this class.
This parameter determines how the collection object stores OID values.
If this parameter is set to 0, then partially-formed OID values (containing only an ID number)
are used. If this parameter is set to 1, then fully-formed OID values (containing both a class
name and an ID number) are used.
parameter ELEMENTTYPE = %ObjectHandle;
The type (class name) of the elements stored in the collection.
parameter INVERSEPERSISTENT = 0;
parameter INVERSEPROPERTY;
parameter PERSISTENT = 0;
Properties
property Cardinality as %RawString [ InitialExpression = ..#CARDINALITY ];
The property name of the inverse relationship in the related class.
method %AddToSaveSet(force As %Integer = 0, refresh As %Integer = 0) as %Status [ Language = objectscript ]
Overrides %SerialObject implementation. Scans objects for modifications in the related list (Element)
and the terminated relationship list (DeleteOref). Modified/Scheduled to delete objects are added to
the save graph.
method %RollBack() as %Status [ Language = objectscript ]
Returns a %Status value indicating success or failure.
method %SerializeObject(ByRef serial As %Binary, partial As %Integer = 0) as %Status [ Language = objectscript ]
This method retrieves all of the serial values for referenced objects and places them into the instance variables
and then validates, normalizes, and serializes the object (with a save of the persistent image if persistent).
method %UnSwizzleAt(key As %String, force As %Integer = 0) as %Status [ Language = objectscript ]
Unswizzles (removes from memory) the individual element at position key in the list.
Returns a %Status value indicating success or failure.
method Clear() as %Status [ Language = objectscript ]
Clears the contents of the array. Both the OID and OREF values are cleared.
Returns a %Status value indicating success or failure.
method Count() as %Integer [ Language = objectscript ]
Returns the number of elements contained in the Relationship.
Starting from, but not including, position key, FindObject finds
the next element in the list whose ID value equals the id from oid ($$$oidPrimary is the id).
If key is a null string, FindObject starts at the beginning
of the list.
FindObject returns the position of the found element or
null string ("") if no element was found.
method FindObjectId(id As %String, key As %String = "") as %String [ Language = objectscript ]
Starting from, but not including, position key, FindObjectId finds
the next element in the list whose ID value equals id.
If key is a null string, FindObjectId starts at the beginning
of the list.
FindObjectId 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 OID value referring to the object at position
key in the list.
Returns the value of the element at location key
or the null OID if no element is found.
method GetExistingObjectNext(ByRef key As %String) as %ObjectIdentity [ Language = objectscript ]
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 the null OID if key is at the end of the list.
method GetNext(ByRef key As %String) as %ObjectHandle [ Language = objectscript ]
Finds and returns the OREF value referring to the object at the position after key
in the list. If key is a null string (""), it returns
the OREF 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.
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 the null OID 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 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 the null OID if key is at the end of the list.
method GetObjectPrevious(ByRef key As %String) as %ObjectIdentity [ Language = objectscript ]
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 the null OID if key is at the beginning of the list.
This method is for internal use only. You should not make direct
use of it within your applications. There is no guarantee made about either
the behavior or future operation of this method.
Finds and returns the OREF at position key in the list without
automatically swizzling the object. Returns $$$NULLOREF if no element is found or if
the referenced object hasn't been swizzled.
method GetPrevious(ByRef key As %String) as %ObjectHandle [ Language = objectscript ]
Finds and returns the OREF value referring to the object at the position before key
in the list. If key is a null string (""), it returns
the OREF 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 the null OREF if key is at the beginning of the list.
Inserts an element with OID value oid at the end of the array.
Returns a %Status value indicating success or failure.
final method InsertObjectId(id As %String) as %Status [ Language = objectscript ]
Inserts an element with ID value id at the end of the array.
Returns a %Status value indicating success or failure.
final method IsDefined(key As %String) as %Boolean [ Language = objectscript ]
Returns true (1) if a value is defined at location key,
otherwise false (0).
method IsEmpty() as %Boolean [ Language = objectscript ]
Returns true if this collection is empty.
To get better performance, if the contents of the collection are not already loaded, then this will run a minimal query
to determine if the collection is empty, and will not actually load the contents.
method Load() as %Status [ Language = objectscript ]
Retrieves a list of all objects related to InverseReference and inserts them into array
of related objects.
final method Next(key As %String = "") as %String [ Language = objectscript ]
Finds and returns the key value of the element at the location following key in the array.
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 ]
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.
