dmaClass_List

A list of elements of a common data type.

Class ID: dmaClass_List
Superclass: DMA

Interfaces

Properties

Name	Impl. Required	System Gen'ed	Read-Only	Value Required	Type	Cardinality	Required Class
OIID	-	Yes	Yes	-	String	Scalar
Class Description	Yes	Yes	Yes	Yes	Object	Scalar	Class Description
This	-	Yes	Yes	Yes	Object	Scalar	List
Create Pending	-	Yes	Yes	Yes	Boolean	Scalar
Update Pending	-	Yes	Yes	Yes	Boolean	Scalar
Delete Pending	-	Yes	Yes	Yes	Boolean	Scalar
Data Type	Yes	Yes	Yes	Yes	Integer32	Scalar
Requires Unique Elements	Yes	Yes	Yes	Yes	Boolean	Scalar
Is Order Preserving	Yes	Yes	Yes	Yes	Boolean	Scalar
Maximum Elements	Yes	Yes	Yes	Yes	Integer32	Scalar
Minimum Elements	Yes	Yes	Yes	Yes	Integer32	Scalar

Detailed Description

The List object contains an ordered, possibly empty sequence of elements having a common data type. Modifiable lists may have elements inserted or deleted at any position in the list. List elements are retrievable by index (zero origin). There are subclasses for lists of each data type.

Property Descriptions

• OIID {dmaProp_OIID}
Property Inherited from DMA

• Class Description {dmaProp_ClassDescription}
Property Inherited from DMA

• This {dmaProp_This}
Property Inherited from DMA

• Create Pending {dmaProp_CreatePending}
Property Inherited from DMA

• Update Pending {dmaProp_UpdatePending}
Property Inherited from DMA

• Delete Pending {dmaProp_DeletePending}
Property Inherited from DMA

• Data Type {dmaProp_DataType}

The data type of the elements in the list.

The DMA data types (in order) are: DmaBinary, DmaBoolean, DmaDateTime, DmaFloat64, DmaId, DmaInteger32, DmaObject, DmaOIID, and DmaString.

The defined symbols for dmaProp_DataType property values for Element Data Type are DMA_DATATYPE_BINARY, DMA_DATATYPE_BOOLEAN, DMA_DATATYPE_DATETIME, DMA_DATATYPE_FLOAT64, DMA_DATATYPE_ID, DMA_DATATYPE_INTEGER32, DMA_DATATYPE_OBJECT, DMA_DATATYPE_STRING, and DMA_DATATYPE_STRING for specifying the respective data types.

• Requires Unique Elements {dmaProp_RequiresUniqueElements}

When true, the values of the list must be unique. Attempting to insert a duplicate value can result in the immediate or deferred failure code DMARC_NOT_UNIQUE. Generally, it is necessary to first delete any unwanted entry that would be duplicated.

When false, the is no requirement for uniqueness of the values.

• Is Order Preserving {dmaProp_IsOrderPreserving}

When true, the order of the elements of the list is preserved. When the list is made persistent in some way, the elements will be returned in precisely the same sequence for all DMA List instances bound before any intervening change occurs.

When false, the list elements may be returned in a different order for future bindings of the persistent object, even though there has been no intervening change in the DMA object. Typically, the persistent implementation has some ordering mechanism that may lead to return of values in a different and not necessarily predictable sequence.

• Maximum Elements {dmaProp_MaximumElements}

There may be no more elements in the list than the number specified by this property.

The value DMA_NO_MAXIMUM (-1) is used to indicate that the list has no fixed maximum on the number of elements that it may carry.

Attempting to insert more elements than specified in this property can result in the immediate or deferred failure code DMA_LIST_BOUNDS_ERROR.

• Minimum Elements {dmaProp_MinimumElements}

There may be no fewer elements in the list than the number specified by this property.

The value 0 is used to indicate that the list is permitted to be empty. A list can be restricted to a specific size by having the same values for dmaProp_MinimumElements and dmaProp_MaximumElements.

Attempting to employ the list when it has fewer elements than specified by this property can lead to an (usually deferred) failure code DMA_LIST_BOUNDS_ERROR. It is desirable that the list implementation tolerate deletions that result in fewer than the minimum number of elements, so the client has an opportunity to complete the list later.