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

%Collection.ArrayOfDT


class %Collection.ArrayOfDT extends
%Collection.AbstractArrayOfDT, Super

The %Collection.ArrayOfDataTypes class represents an array of literal (i.e., data type) elements, each of which is associated with a unique key value. Keys can have any value, string or numeric. 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 %ArrayOfDataTypes.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
15


Summary


Properties
ElementClassType ElementType LiteralBehavior OrefStorage
Owner ReadOnly Storage StreamLocation

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%Disconnect %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IncrementCount %IsA
%IsModified %IsNull %New %NormalizeObject
%ObjectModified %OriginalNamespace %PackageName %RemoveFromSaveSet
%SerializeObject %SetModified %ValidateObject BuildValueArray
Clear Count DeSerialize Define
DisplayToLogical Find GetAt GetNext
GetPrevious IsDefined LogicalToDisplay LogicalToOdbc
Next OdbcToLogical Previous RemoveAt
Serialize SetAt

Subclasses
%Collection.MV.ArrayOfDT

Methods


• method Count() as %Integer
Returns the number of elements contained in the array.
• method DeSerialize(serialized As %String(MAXLEN="")) as %Status
Deserialize from string created with Serialize back to collection
• method Define(key As %String) as %Boolean
This method is deprecated.

Please use IsDefined instead.

• classmethod DisplayToLogical(val As %String = "", delim As %String = {$c(13, 10)}, class As %String = "", method As %String = "") as %String
Converts the value of an incoming delimited string to a serialized state using delim as a delimiter.
• method Find(element As %String, key As %String) as %String
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.

• method GetAt(key As %String = "") as %String
Finds and returns the value of the element associated with key.

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

• method GetNext(ByRef key As %String) as %String
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.

• method GetPrevious(ByRef key As %String) as %String
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.

• method IsDefined(key As %String) as %Boolean
Returns true (1) if a value is defined at location key, otherwise false (0).
• classmethod LogicalToDisplay(val As %String = "", delim As %String = {$c(13, 10)}, class As %String = "", method As %String = "") as %String
Converts the serial state of this array object to a delimited string using delim as a delimiter.
• method Next(key As %String = "") as %String
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.
• method Previous(key As %String = "") as %String
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.
• method RemoveAt(key As %String) as %String
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.

• method Serialize(force As %Integer = 0) as %String
Serialize() constructs a serialized form of the collection as a string
• method SetAt(element As %String, key As %String) as %Status
Sets the value of the element associated with key to element.

Returns a %Status value indicating success or failure.