Skip to main content

%Collection.Super

Class %Collection.Super Extends %RegisteredObject [ System = 2 ]

Functions needed for all collection classes

Parameters​

ELEMENTTYPE​

Parameter ELEMENTTYPE = "%String";

The type (class name) of the elements stored in the collection.

Properties​

ElementType​

Property ElementType As %RawString [ InitialExpression = {..#ELEMENTTYPE} ];

The type (classname:propertyname) of the elements stored in the collection.

Owner​

Property Owner As %String;

Integer version of the object that has the collection data

Storage​

Property Storage As %Integer;

OrefStorage​

Property OrefStorage As %Integer;

LiteralBehavior​

Property LiteralBehavior As %Integer [ InitialExpression = 0 ];

True if this collection is a 'literal object' so the Insert/Set should make a copy of the object before inserting it.

ElementClassType​

Property ElementClassType As %String;

The ClassType of the elements stored by this collection

StreamLocation​

Property StreamLocation As %String;

For stream collections this contains the stream root location

ReadOnly​

Property ReadOnly As %Boolean;

True if this collection is read only

orefData​

Property orefData As %String [ MultiDimensional, Private ];

If the collection is disconnected this is where the oref data is stored

oidData​

Property oidData As %String [ MultiDimensional, Private ];

If the collection is disconnected this is where the oid data is stored

Methods​

%IsModified​

Method %IsModified() As %Integer [ CodeMode = expression ]

%SetModified​

Method %SetModified(val As %Boolean) As %Status

Clear​

Method Clear() As %Status

Clears the contents of the array. Both the OID value is cleared.

Returns a %Status value indicating success or failure.

%Disconnect​

Method %Disconnect() As %Status

Called when the parent object is about to be removed so this collection can exist in a disconnected state. It makes a copy of the parents collection information.

%OnConstructClone​

Method %OnConstructClone(object As %RegisteredObject, deep As %Boolean = 0, ByRef cloned As %String) As %Status [ Private, ServerOnly = 1 ]

Serialize​

Method Serialize(force As %Integer = 0) As %String(MAXLEN="") [ Abstract ]

Serialize constructs a serialized form of the collection as a string

DeSerialize​

Method DeSerialize(serialized As %String(MAXLEN="")) As %Status [ Abstract ]

Deserialize from string created with Serialize back to collection