ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.dct.model 

DEPDictionaryModel  - AS3 Data Dictionary

Packagecom.adobe.dct.model
Classpublic class DEPDictionaryModel
InheritanceDEPDictionaryModel Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The DEPDictionaryModel class represents the domain object for the assets of type DataDictionary which is used as data provider for DataElementsPanel. Domain objects can be leveraged to build presentation on top of them. They ease the process of coding views by abstracting all the service calls and maintaining meaningful states.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  description : String
The description of the DEPDictionaryModel.
DEPDictionaryModel
  name : String
Gets the unique name of the Data Dictionary.
DEPDictionaryModel
  rootDataElement : DataElementModel
The root DataElementModel within the data dictionary.
DEPDictionaryModel
  type : String
Gets the TYPE of the Data Dictionary.
DEPDictionaryModel
  vo : DataDictionary
The underlying Data Dictionary value object.
DEPDictionaryModel
Public Methods
 MethodDefined By
 Inherited
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
  
[static] Creates the domain object from the corresponding value object.
DEPDictionaryModel
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Public Constants
 ConstantDefined By
  TYPE_PERSISTENT : String = "PERSISTENT"
[static] The constant corresponding to the persistent data dictionary.
DEPDictionaryModel
  TYPE_TRANSIENT : String = "TRANSIENT"
[static] The constant corresponding to the placeholder DD.
DEPDictionaryModel
Property Detail

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

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



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

name

property 
name: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 Data Dictionary.



Implementation
    public function get name():String
    public function set name(value:String):void

rootDataElement

property 
rootDataElement:DataElementModel

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The root DataElementModel within the data dictionary.



Implementation
    public function get rootDataElement():DataElementModel
    public function set rootDataElement(value:DataElementModel):void

Related API Elements

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



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

vo

property 
vo:DataDictionary

Language Version: ActionScript 3.0
Product Version: Data Dictionary Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The underlying Data Dictionary value object.



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

createFromVO

()method
public static function createFromVO(dataDictionaryVO:DataDictionary):DEPDictionaryModel

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

dataDictionaryVO:DataDictionary — The value object of the type Category

Returns
DEPDictionaryModel — The Category domain object corresponding the passed Category value object.
Constant Detail

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 persistent data dictionary.

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