com.adobe.dct.model

# DataElementModel - AS3 Data Dictionary

Package | com.adobe.dct.model
Class | public class DataElementModel
Inheritance | DataElementModel EventDispatcher Object

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The domain class for the DataElement.

DataElement are defined by ... ....

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | childElements : IList The list of Child DataElementModel. | DataElementModel
|  | collectionDepth : int Returns the Collection depth of a DataElements | DataElementModel
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | dataDictionaryName : String The name of data dictionary. | DataElementModel
|  | dataType : String Gets the DATATYPE of the DataElement. | DataElementModel
|  | description : String The description of the DataElementModel. | DataElementModel
|  | displayName : String Gets the display name of the DataElement. | DataElementModel
|  | isCollection : Boolean [read-only] Returns if the DataElements is a Collection | DataElementModel
|  | protect : Boolean Gets if the data element is protected | DataElementModel
|  | referenceName : String Gets the unique name of the DataElement. | DataElementModel
|  | subType : String The SubType of DataElementModel: Enum. | DataElementModel
|  | type : String Gets the TYPE of the DataElement. | DataElementModel
|  | valueSet : IList Allowed values for a DataElementModel. | DataElementModel
|  | vo : DataDictionaryElement The underlying value object corresponding to this DataElement. | DataElementModel

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | EventDispatcher
|  | copy():DataElementModel Returns a copy of the data elemnt model object. | DataElementModel
|  | createFromVO(vo:DataDictionaryElement, dataDictionaryName:String, type:String, collectionDepth:int = 0):DataElementModel [static] Creates the domain object from the corresponding value object. | DataElementModel
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher

Public Constants

| Constant | Defined By
--- | --- | ---
|  | DATATYPE_BOOLEAN : String = "BOOLEAN" [static] The DataElementModel.DATATYPE_BOOLEAN constant defines the value of the dataType property of the DataElementModel of DATATYPE_BOOLEAN type. | DataElementModel
|  | DATATYPE_COMPOSITE : String = "COMPOSITE" [static] The DataElementModel.DATATYPE_COMPOSITE constant defines the value of the dataType property of the DataElementModel of DATATYPE_COMPOSITE type. | DataElementModel
|  | DATATYPE_DATE : String = "DATE" [static] The DataElementModel.DATATYPE_DATE constant defines the value of the dataType property of the DataElementModel of DATATYPE_DATE type. | DataElementModel
|  | DATATYPE_NUMBER : String = "NUMBER" [static] The DataElementModel.DATATYPE_NUMBER constant defines the value of the dataType property of the DataElementModel of DATATYPE_NUMBER type. | DataElementModel
|  | DATATYPE_STRING : String = "STRING" [static] The DataElementModel.DATATYPE_STRING constant defines the value of the dataType property of the DataElementModel of DATATYPE_STRING type. | DataElementModel
|  | SUBTYPE_ENUM : String = "ENUM" [static] The DataElementModel.SUBTYPE_ENUM constant defines the value of the subType property of the DataElementModel of SUBTYPE_ENUM type. | DataElementModel
|  | TYPE_PERSISTENT : String = "PERSISTENT" [static] The constant corresponding to the data dictionary variables. | DataElementModel
|  | TYPE_TRANSIENT : String = "TRANSIENT" [static] The constant corresponding to the placeholder variables. | DataElementModel

Property Detail

### childElements

property

`childElements:IList`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10 It contains the child DataElement List associated with this Data Element.

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The list of Child DataElementModel.

Implementation
`public function get childElements():IList`
`public function set childElements(value:IList):void`

### collectionDepth

property

`collectionDepth:int`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Returns the Collection depth of a DataElements

Implementation
`public function get collectionDepth():int`
`public function set collectionDepth(value:int):void`

### dataDictionaryName

property

`dataDictionaryName:String`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The name of data dictionary.

Implementation
`public function get dataDictionaryName():String`
`public function set dataDictionaryName(value:String):void`

### dataType

property

`dataType:String`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Gets the DATATYPE of the DataElement.

Implementation
`public function get dataType():String`
`public function set dataType(value:String):void`

### description

property

`description:String`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The description of the DataElementModel.

Implementation
`public function get description():String`
`public function set description(value:String):void`

### displayName

property

`displayName:String`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Gets the display name of the DataElement.

Implementation
`public function get displayName():String`
`public function set displayName(value:String):void`

### isCollection

property

`isCollection:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Returns if the DataElements is a Collection

Implementation
`public function get isCollection():Boolean`

### protect

property

`protect:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Gets if the data element is protected

Implementation
`public function get protect():Boolean`
`public function set protect(value:Boolean):void`

### referenceName

property

`referenceName:String`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Gets the unique name of the DataElement.

Implementation
`public function get referenceName():String`
`public function set referenceName(value:String):void`

### subType

property

`subType:String`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The SubType of DataElementModel: Enum.

Implementation
`public function get subType():String`
`public function set subType(value:String):void`

### type

property

`type:String`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Gets the TYPE of the DataElement.

Implementation
`public function get type():String`
`public function set type(value:String):void`

### valueSet

property

`valueSet:IList`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Allowed values for a DataElementModel.

Implementation
`public function get valueSet():IList`
`public function set valueSet(value:IList):void`

### vo

property

`vo:DataDictionaryElement`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The underlying value object corresponding to this DataElement.

Implementation
`public function get vo():DataDictionaryElement`
`public function set vo(value:DataDictionaryElement):void`
Method Detail

### copy

()
method

`public function copy():DataElementModel`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Returns a copy of the data elemnt model object.

Returns

| `DataElementModel` — a copy of the data elemnt model object

### createFromVO

()
method

`public static function createFromVO(vo:DataDictionaryElement, dataDictionaryName:String, type:String, collectionDepth:int = 0):DataElementModel`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Creates the domain object from the corresponding value object.

Value Objects are pure data entities mostly acting as parameters to the server apis. Domain objects are build atop to provide more meaningful business data and behavior thereby enabling faster and convenient UI view development.

Parameters

| `vo:DataDictionaryElement` — The value object of the type DataDictionaryElement
| `dataDictionaryName:String` — The name of data dictionary.
| `type:String` (default = `NaN`)`` — The type of data element which can be one of `DataElementModel.TYPE_PERSISTENT` or `DataElementModel.TYPE_TRANSIENT`
| `collectionDepth:int` (default = `0`)`` — is equal to the dimensions of highest ancestor which is collection. The value is zero for a non collection data element.

Returns

| `DataElementModel` — The Data Element domain object corresponding the passed DataDictionaryElement value object.

Constant Detail

### DATATYPE_BOOLEAN

Constant

`public static const DATATYPE_BOOLEAN:String = "BOOLEAN"`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The `DataElementModel.DATATYPE_BOOLEAN` constant defines the value of the `dataType` property of the DataElementModel of `DATATYPE_BOOLEAN` type.

### DATATYPE_COMPOSITE

Constant

`public static const DATATYPE_COMPOSITE:String = "COMPOSITE"`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The `DataElementModel.DATATYPE_COMPOSITE` constant defines the value of the `dataType` property of the DataElementModel of `DATATYPE_COMPOSITE` type.

### DATATYPE_DATE

Constant

`public static const DATATYPE_DATE:String = "DATE"`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The `DataElementModel.DATATYPE_DATE` constant defines the value of the `dataType` property of the DataElementModel of `DATATYPE_DATE` type.

### DATATYPE_NUMBER

Constant

`public static const DATATYPE_NUMBER:String = "NUMBER"`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The `DataElementModel.DATATYPE_NUMBER` constant defines the value of the `dataType` property of the DataElementModel of `DATATYPE_NUMBER` type.

### DATATYPE_STRING

Constant

`public static const DATATYPE_STRING:String = "STRING"`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10

The `DataElementModel.DATATYPE_STRING` constant defines the value of the `dataType` property of the DataElementModel of `DATATYPE_STRING` type.

### SUBTYPE_ENUM

Constant

`public static const SUBTYPE_ENUM:String = "ENUM"`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The `DataElementModel.SUBTYPE_ENUM` constant defines the value of the `subType` property of the DataElementModel of `SUBTYPE_ENUM` type.

### TYPE_PERSISTENT

Constant

`public static const TYPE_PERSISTENT:String = "PERSISTENT"`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The constant corresponding to the data dictionary variables.

### TYPE_TRANSIENT

Constant

`public static const TYPE_TRANSIENT:String = "TRANSIENT"`

Language Version: | ActionScript 3.0

Product Version: | Data Dictionary Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The constant corresponding to the placeholder variables.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00