Inheritance diagram for ListOfDT:

[legend]

Collaboration diagram for ListOfDT:

[legend]

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

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

_.Library.String	Find (_.Library.String element, _.Library.Integer key)
	Starting from, and including, position key, Find finds. More...

_.Library.String	GetAt (_.Library.Integer key)
	Finds and returns the value of the element at position. More...

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

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

_.Library.Status	Insert (_.Library.String element)
	Inserts an element with value element at the end of the list. More...

_.Library.Status	InsertAt (_.Library.String element, _.Library.Integer key)
	Inserts an element with value element at position key. More...

_.Library.Status	InsertList (_.Library.String inslist)
	Inserts a list with value inslist at the end of the list. More...

_.Library.Status	InsertOrdered (_.Library.String element)
	Inserts an element with value element into the list at the correct ordered. More...

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

_.Library.Integer	Next (_.Library.Integer key)
	Finds and returns the index value of the element at the location following key in the list. More...

_.Library.Integer	Previous (_.Library.Integer key)
	Finds and returns the index value of the element at the location preceding key in the list. More...

_.Library.String	RemoveAt (_.Library.Integer key)
	Removes the element at position key in the list. 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.Integer key)
	Sets the value of the element at position key to element. More...

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

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

_.Library.Status	Insert (_.Library.RawString element)
	Inserts an element with value element at the end of the list. More...

_.Library.Status	InsertAt (_.Library.RawString element, _.Library.Integer key)
	Inserts an element with value element at position key. More...

_.Library.Status	InsertList (_.Library.RawString inslist)
	Inserts a list with value inslist at the end of the list. More...

_.Library.Status	InsertOrdered (_.Library.RawString element)
	Inserts an element with value element into the list at the correct ordered. More...

_.Library.Status	SetAt (_.Library.RawString element, _.Library.Integer key)
	Sets the value of the element at position 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	FDBMSToLogical (_.Library.String val, _.Library.String delim)
	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 list object to a delimited string. More...

_.Library.String	LogicalToFDBMS (_.Library.String val, _.Library.String delim)
	Converts the serial state of this list object to a delimited string. More...

Static Public Member Functions inherited from AbstractList
_.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 list 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...

Public Attributes
	Size
	Size is the number of elements contained in the list. More...

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...

Additional Inherited Members
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.ListOfDT</CLASS> class represents a list of literal (i.e., data type) values each of which is associated with a numeric position in the list. The first element in the list is stored at position 1.

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>ListOfDataTypes</class>.

Member Function Documentation

◆ Count()

_.Library.Integer Count ( )

Returns the number of elements contained in the list.

For information on this class, see Working with Collections.

The <CLASS>Collection.ListOfDT</CLASS> class represents a list of literal (i.e., data type) values each of which is associated with a numeric position in the list. The first element in the list is stored at position 1.

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>ListOfDataTypes</class>.

Reimplemented from AbstractList.

◆ 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 the value of the delim argument as a delimiter.

Reimplemented in ListOfDT.

◆ FDBMSToLogical()

_.Library.String FDBMSToLogical	(	_.Library.String	val,
		_.Library.String	delim
	)

static

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

using the value of the delim argument as a delimiter.

◆ Find()

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

Starting from, and including, position key, Find finds.

the next element in the list with value equal to element. If key is a null string, Find starts at the beginning of the list.

Find returns the position of the found element or null string ("") if no element was found.

Reimplemented from AbstractListOfDT.

◆ GetAt()

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

Finds and returns the value of the element at position.

key in the list.

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

Reimplemented from AbstractListOfDT.

◆ GetNext()

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

Finds and returns the value of the element at the position after key

in the list. If key is a null string (""), it returns the value of the first element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the end of the list.

Reimplemented from AbstractListOfDT.

◆ GetPrevious()

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

Finds and returns the value of the element at the position before key

in the list. If key is a null string (""), it returns the value of the last element in the list.

The value of key, which is passed by reference, is updated to the position value of the returned element or null string ("") if key is at the beginning of the list.

Reimplemented from AbstractListOfDT.

◆ Insert()

_.Library.Status Insert ( _.Library.String element )

Inserts an element with value element at the end of the list.

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

Reimplemented from AbstractListOfDT.

◆ InsertAt()

_.Library.Status InsertAt	(	_.Library.String	element,
		_.Library.Integer	key
	)

Inserts an element with value element at position key.

<p>To make room for the new element, the elements previously at or following position 
<var>key</var> are moved up by one position.
<p><var>key</var> must be in the following range: 
<blockquote><code>
1 &lt= key &lt= Count() + 1
</blockquote></code>

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

Reimplemented from AbstractListOfDT.

◆ InsertList()

_.Library.Status InsertList ( _.Library.String inslist )

Inserts a list with value inslist at the end of the list.

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

Reimplemented from AbstractListOfDT.

Reimplemented in ListOfDT.

◆ InsertOrdered()

_.Library.Status InsertOrdered ( _.Library.String element )

Inserts an element with value element into the list at the correct ordered.

position. The elements in the list are shifted to accommodate the new element as necessary.

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

Reimplemented from AbstractListOfDT.

◆ IsDefined()

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

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

otherwise false (0).

◆ LogicalToDisplay()

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

static

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

using the value of the delim argument as a delimiter.

Reimplemented in ListOfDT.

◆ LogicalToFDBMS()

_.Library.String LogicalToFDBMS	(	_.Library.String	val,
		_.Library.String	delim
	)

static

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

using the value of the delim argument as a delimiter.

◆ Next()

_.Library.Integer Next ( _.Library.Integer key )

Finds and returns the index value of the element at the location following key in the list.

If key is a null string (""), then Next returns the position of the first element in the list (1).

Reimplemented from AbstractList.

◆ Previous()

_.Library.Integer Previous ( _.Library.Integer key )

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

If key is a null string (""), then Next returns the position of the last element in the list.

Reimplemented from AbstractList.

◆ RemoveAt()

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

Removes the element at position key in the list.

The elements following position key are moved to fill in the resulting gap.

RemoveAt returns the value of the removed element or null string ("") if no element was removed.

Reimplemented from AbstractListOfDT.

◆ SetAt()

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

Sets the value of the element at position key to element.

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

Reimplemented from AbstractListOfDT.

Member Data Documentation

◆ Size

Size

Size is the number of elements contained in the list.

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Count()

◆ DisplayToLogical()

◆ FDBMSToLogical()

◆ Find()

◆ GetAt()

◆ GetNext()

◆ GetPrevious()

◆ Insert()

◆ InsertAt()

◆ InsertList()

◆ InsertOrdered()

◆ IsDefined()

◆ LogicalToDisplay()

◆ LogicalToFDBMS()

◆ Next()

◆ Previous()

◆ RemoveAt()

◆ SetAt()

Member Data Documentation

◆ Size