Home > Class Reference > ENSLIB namespace > %Collection.ListOfStream

%Collection.ListOfStream

class %Collection.ListOfStream extends %Collection.ListOfObj

These %Collection classes can only be used when you have a collection property of another object as they rely on storing the data inside the parent object, they can not be used as 'stand alone' collections, for this use the %ListOfObjects.

Method Inventory (Including Private)

Methods (Including Private)

private method %OnConstructClone(oref As %RegisteredObject, deep As %Boolean = 0, ByRef cloned As %String) as %Status
Inherited description: This callback method is invoked by the %ConstructClone() method to provide notification that a clone of an object is being created. It passes in the oref of the object that was cloned in object.

If this method returns an error then the object will not be created.

method GetAt(key As %Integer) as %RegisteredObject
Inherited description: Finds and returns the OREF value referring to the object at position key in the list.

GetAt returns the value of the element at location key or null string ("") if no element is found.

method Insert(oref As %RegisteredObject) as %Status
Inherited description: Inserts an element with OREF value oref at the end of the list.

Returns a %Status value indicating success or failure.

method InsertAt(oref As %RegisteredObject, key As %Integer) as %Status
Inherited description: Inserts an element with OREF value oref at position key.

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.
final method InsertObjectId(id As %String) as %Status
Inherited description: Inserts an element with ID value id at the end of the list.

Returns a %Status value indicating success or failure.

final method InsertObjectIdAt(id As %String, key As %Integer) as %Status
Inherited description: Inserts an element with ID value id at position key.

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.
method SetAt(oref As %RegisteredObject, key As %Integer) as %Status
Inherited description: Sets the OREF value of the element at position key to oref.

Returns a %Status value indicating success or failure.

final method SetObjectIdAt(id As %String, key As %Integer) as %Status
Inherited description: Sets the ID value of the element at position key to id.

Returns a %Status value indicating success or failure.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)