Inheritance diagram for ArrayOfDT:

[legend]

Collaboration diagram for ArrayOfDT:

[legend]

Public Member Functions
_.Library.Integer	Count ()
	Returns the number of elements contained in the array. More...

_.Library.Status	DeSerialize (_.Library.String serialized)
	Deserialize from string created with <method>Serialize</method> back to collection.

_.Library.Boolean	Define (_.Library.String key)
	This method is deprecated. More...

_.Library.String	Find (_.Library.String element, _.Library.String key)
	Starting from, but not including, location key,. More...

_.Library.String	GetAt (_.Library.String key)
	Finds and returns the value of the element associated with key. More...

_.Library.String	GetNext (_.Library.String key)
	Finds and returns the value of the element at the location after key More...

_.Library.String	GetPrevious (_.Library.String key)
	Finds and returns the value of the element at the location before key More...

_.Library.Boolean	IsDefined (_.Library.String key)
	Returns true (1) if a value is defined at location key,. More...

_.Library.String	Next (_.Library.String key)
	Finds and returns the key value of the element at the location following key in the array. More...

_.Library.String	Previous (_.Library.String key)
	Finds and returns the key value of the element at the location preceding key in the array. More...

_.Library.String	RemoveAt (_.Library.String key)
	Removes the element associated with key in the array. More...

_.Library.String	Serialize (_.Library.Integer force)
	Serialize() constructs a serialized form of the collection as a string.

_.Library.Status	SetAt (_.Library.String element, _.Library.String key)
	Sets the value of the element associated with key to element. More...

Public Member Functions inherited from AbstractArray
_.Library.Status	Clear ()
	Clears the contents of the array. More...

_.Library.String	Find (_.Library.RawString element, _.Library.String key)
	Starting from, but not including, location key,. More...

_.Library.Status	SetAt (_.Library.RawString element, _.Library.String key)
	Sets the value of the element associated with key to element. More...

Public Member Functions inherited from AbstractIterator
_.Library.RawString	GetAt (_.Library.RawString key)
	Definition of iterator methods that all our collections classes use to ensure consistency. More...

_.Library.RawString	GetNext (_.Library.RawString key)
	Finds and returns the value of the element at the location after key More...

_.Library.RawString	Next (_.Library.RawString key)
	Finds and returns the key value of the element at the location following key in the iteration. More...

Public Member Functions inherited from Super
_.Library.Status	Clear ()
	Clears the contents of the array. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.Library.String	DisplayToLogical (_.Library.String val, _.Library.String delim, _.Library.String class, _.Library.String method)
	Converts the value of an incoming delimited string to a serialized state. More...

_.Library.String	LogicalToDisplay (_.Library.String val, _.Library.String delim, _.Library.String class, _.Library.String method)
	Converts the serial state of this array object to a delimited string. More...

Static Public Member Functions inherited from AbstractArray
_.Library.Status	BuildValueArray (_.Library.Binary serialized, _.Library.Binary array)
	Constructs array(key)=value for each element in the serialval value. More...

_.Library.String	LogicalToOdbc (_.Library.String val, _.Library.String delim, _.Library.String class, _.Library.String method)
	Converts the serial state of this array object to a delimited string. More...

_.Library.String	OdbcToLogical (_.Library.String val, _.Library.String delim, _.Library.String class, _.Library.String method)
	Converts the value of an incoming delimited string to a serialized state. More...

Additional Inherited Members
Public Attributes inherited from Super
	ElementClassType
	The ClassType of the elements stored by this collection. More...

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

	LiteralBehavior
	True if this collection is a 'literal object' so the Insert/Set should make a copy of the object. More...

	OrefStorage
	More...

	Owner
	Integer version of the object that has the collection data. More...

	ReadOnly
	True if this collection is read only. More...

	Storage
	More...

	StreamLocation
	For stream collections this contains the stream root location. More...

Static Public Attributes inherited from AbstractArray
	ELEMENTTYPE = None
	The type (class name) of the elements stored in the collection.

Static Public Attributes inherited from Super
	ELEMENTTYPE = None
	Functions needed for all collection classes. More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

For information on this class, see Working with Collections.

The <CLASS>Collection.ArrayOfDataTypes</CLASS> 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 cannot be used as 'standalone' collections, for this use the <class>ArrayOfDataTypes</class>.

Member Function Documentation

◆ Count()

_.Library.Integer Count ( )

Returns the number of elements contained in the array.

For information on this class, see Working with Collections.

The <CLASS>Collection.ArrayOfDataTypes</CLASS> 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 cannot be used as 'standalone' collections, for this use the <class>ArrayOfDataTypes</class>.

Reimplemented from AbstractArray.

◆ Define()

_.Library.Boolean Define ( _.Library.String key )

This method is deprecated.

Please use <METHOD>IsDefined</METHOD> instead.

Reimplemented from AbstractArray.

◆ DisplayToLogical()

_.Library.String DisplayToLogical	(	_.Library.String	val,
		_.Library.String	delim,
		_.Library.String	class,
		_.Library.String	method
	)

static

Converts the value of an incoming delimited string to a serialized state.

using delim as a delimiter.

◆ Find()

_.Library.String Find	(	_.Library.String	element,
		_.Library.String	key
	)

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.

Reimplemented from AbstractArrayOfDT.

◆ GetAt()

_.Library.String GetAt ( _.Library.String key )

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.

Reimplemented from AbstractArrayOfDT.

◆ GetNext()

_.Library.String GetNext ( _.Library.String key )

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.

Reimplemented from AbstractArrayOfDT.

◆ GetPrevious()

_.Library.String GetPrevious ( _.Library.String key )

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.

Reimplemented from AbstractArrayOfDT.

◆ IsDefined()

_.Library.Boolean IsDefined ( _.Library.String key )

Returns true (1) if a value is defined at location key,.

otherwise false (0).

Reimplemented from AbstractArray.

◆ LogicalToDisplay()

_.Library.String LogicalToDisplay	(	_.Library.String	val,
		_.Library.String	delim,
		_.Library.String	class,
		_.Library.String	method
	)

static

Converts the serial state of this array object to a delimited string.

using delim as a delimiter.

◆ Next()

_.Library.String Next ( _.Library.String key )

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.

◆ Previous()

_.Library.String Previous ( _.Library.String key )

Finds and returns the key value of the element at the location preceding key in the array.

If key is a null string (""), then <METHOD>Previous</METHOD> returns the key value for the last element in the array.

Reimplemented from AbstractArray.

◆ RemoveAt()

_.Library.String RemoveAt ( _.Library.String key )

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.

Reimplemented from AbstractArrayOfDT.

◆ SetAt()

_.Library.Status SetAt	(	_.Library.String	element,
		_.Library.String	key
	)

Sets the value of the element associated with key to element.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

Reimplemented from AbstractArrayOfDT.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Count()

◆ Define()

◆ DisplayToLogical()

◆ Find()

◆ GetAt()

◆ GetNext()

◆ GetPrevious()

◆ IsDefined()

◆ LogicalToDisplay()

◆ Next()

◆ Previous()

◆ RemoveAt()

◆ SetAt()