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 

DataDictionaryInstanceModel  - AS3 Data Dictionary
Packagecom.adobe.dct.model
Classpublic class DataDictionaryInstanceModel
InheritanceDataDictionaryInstanceModel 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 domain class for the DataDictionaryInstance.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataDictionary : DataDictionary
The data dictionary corresponding to the data dictionary instance model.
DataDictionaryInstanceModel
  vo : DataDictionaryInstance
The underlying data dictionary instance value object.
DataDictionaryInstanceModel
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
  
createFromVO(vo:DataDictionaryInstance):DataDictionaryInstanceModel
[static] Creates the domain object from the corresponding value object.
DataDictionaryInstanceModel
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
getValue(key:String):Object
The value of a data dictionary element given its unique name(referenceName).
DataDictionaryInstanceModel
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
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
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
  
setValue(varName:String, value:Object):void
Set the value of a data dictionary element given its unique name(reference name).
DataDictionaryInstanceModel
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail

dataDictionary

property
dataDictionary:DataDictionary

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

The data dictionary corresponding to the data dictionary instance model.



Implementation
    public function get dataDictionary():DataDictionary
    public function set dataDictionary(value:DataDictionary):void

vo

property 
vo:DataDictionaryInstance

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

The underlying data dictionary instance value object.



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

createFromVO

()method
public static function createFromVO(vo:DataDictionaryInstance):DataDictionaryInstanceModel

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:DataDictionaryInstance — The value object of the type DataDictionaryInstance.

Returns
DataDictionaryInstanceModel — The Data Element domain object corresponding the passed DataDictionaryElement value object.

getValue

()method 
public function getValue(key:String):Object

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

The value of a data dictionary element given its unique name(referenceName).

Parameters

key:String — reference name of a data dictionary element.

Returns
Object — value for data dictionary element in the data dictionary instance model.

A value of null if the value of data dictionary element is null. undefined if the data dictionary element key is missing in data dictionary instance. typed value if the value for data dictionary element is present in DDI.

setValue

()method 
public function setValue(varName:String, value:Object):void

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

Set the value of a data dictionary element given its unique name(reference name). The value of primitive, composite and top Level collection elements can be set using this method. It doesn't allow setting the value inside a collection and there is no support for index.

Parameters

varName:String — reference name of the data dictionary element.
 
value:Object — the value of data dictionary element to be set inside the data dictionary instance model.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy