Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %Collection.ListOfStream
Private  Storage   

%Collection.ListOfStream


class %Collection.ListOfStream extends
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.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
8


Summary


Properties
ElementClassType ElementType LiteralBehavior OrefStorage
Owner ReadOnly Size Storage
StreamLocation

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 %UnSwizzleAt %ValidateObject BuildValueArray
Clear Count DeSerialize Find
FindObjectId FindOref GetAt GetNext
GetObjectAt GetObjectIdAt GetObjectIdNext GetObjectIdPrevious
GetObjectNext GetObjectPrevious GetPrevious Insert
InsertAt InsertList InsertObject InsertObjectAt
InsertObjectId InsertObjectIdAt InsertOrdered IsDefined
LogicalToOdbc Next OdbcToLogical Previous
RemoveAt Serialize SetAt SetObjectAt
SetObjectIdAt SizeGet SizeSet

Subclasses
%Collection.MV.ListOfStream

Methods


• method GetAt(key As %Integer) as %RegisteredObject
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
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
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
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
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
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
Sets the ID value of the element at position key to id.

Returns a %Status value indicating success or failure.