ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.data 

ManagedAssociation  - AS3 ADEP Data Services
Packagemx.data
Classpublic class ManagedAssociation
InheritanceManagedAssociation Inheritance Object
Implements IExternalizable

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

This class is used to represent an association as part of the data management metadata. An association is used to represent a property of one object which refers to an instance or collection of instance of another managed type. These instances may be created automatically from server side configuration or automatically in the code generated wrappers. It is also possible to create these in those cases where the configuration is defined entirely in the runtime ActionScript code.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  destination : String
Destination this association references.
ManagedAssociation
  hierarchicalEvents : Boolean
Indicates whether or not the parent of this association receives events from properties of the objects referenced by the association.
ManagedAssociation
  lazy : Boolean
If true, the value of the association property is loaded on the client the first time it is accessed instead of when the referencing object is loaded.
ManagedAssociation
  loadOnDemand : Boolean
Indicates whether or not this association's value is retrieved from the server when the original item state is retrieved.
ManagedAssociation
  pagedUpdates : Boolean = false
When true, updates to the set of associated instances for this association are made in increments of pageSize.
ManagedAssociation
  pageSize : int = 0
Size of page to use for communication of changes to the set of associated instances for this association.
ManagedAssociation
  property : String
Name of the property that this association is established on.
ManagedAssociation
  readOnly : Boolean
Contains true if this association is read-only from the perspective of the assembler.
ManagedAssociation
  type : String
Indicates what type of association this is.
ManagedAssociation
  typeCode : uint
[read-only] Indicates what type of association this is.
ManagedAssociation
Public Methods
 MethodDefined By
  
ManagedAssociation(info:XML = null)
Constructs an instance of metadata with the specified XML snippet that contains the relationship and service reference information.
ManagedAssociation
  
getAttributeMask():uint
Bit mask representing the attributes of this managed association.
ManagedAssociation
 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
  
readExternal(input:IDataInput):void
ManagedAssociation
  
setAttributeMask(mask:uint):void
Sets the attributes of this association based on the passed in bit mask.
ManagedAssociation
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
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.
ManagedAssociation
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
  
writeExternal(output:IDataOutput):void
This method will serialize this cache to the specified output stream.
ManagedAssociation
Public Constants
 ConstantDefined By
  MANY : uint = 0
[static] Indicates that this is a many-to-many or one-to-many relationship.
ManagedAssociation
  MANY_TO_MANY : String = "many-to-many"
[static] Indicates that this is a many-to-many relationship.
ManagedAssociation
  MANY_TO_ONE : String = "many-to-one"
[static] Indicates that this is a many-to-one relationship.
ManagedAssociation
  ONE : uint = 1
[static] Indicates that this is a one-to-one relationship.
ManagedAssociation
  ONE_TO_MANY : String = "one-to-many"
[static] Indicates that this is a one-to-many relationship.
ManagedAssociation
  ONE_TO_ONE : String = "one-to-one"
[static] Indicates that this is a one-to-one relationship.
ManagedAssociation
Property Detail

destination

property
destination:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Destination this association references. Any property configured as an association must reference another data service destination.



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

hierarchicalEvents

property 
hierarchicalEvents:Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates whether or not the parent of this association receives events from properties of the objects referenced by the association.



Implementation
    public function get hierarchicalEvents():Boolean
    public function set hierarchicalEvents(value:Boolean):void

lazy

property 
lazy:Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

If true, the value of the association property is loaded on the client the first time it is accessed instead of when the referencing object is loaded.



Implementation
    public function get lazy():Boolean
    public function set lazy(value:Boolean):void

loadOnDemand

property 
loadOnDemand:Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates whether or not this association's value is retrieved from the server when the original item state is retrieved.



Implementation
    public function get loadOnDemand():Boolean
    public function set loadOnDemand(value:Boolean):void

pagedUpdates

property 
public var pagedUpdates:Boolean = false

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

When true, updates to the set of associated instances for this association are made in increments of pageSize. When false, the entire set is updated at once.

pageSize

property 
public var pageSize:int = 0

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Size of page to use for communication of changes to the set of associated instances for this association. Only relevant when pagedUpdates is true.

property

property 
property:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Name of the property that this association is established on.



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

readOnly

property 
readOnly:Boolean

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Contains true if this association is read-only from the perspective of the assembler. Usually this is set to true on the inverse side of an association. The assembler does not have to persist a value change from a read-only association so they are not passed to the change handler. You should typically still update the read-only association property in your code as FDMS does not update the inverse side of the relationship automatically.



Implementation
    public function get readOnly():Boolean
    public function set readOnly(value:Boolean):void

type

property 
type:String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates what type of association this is. Values are: Association.MANY or Association.ONE.



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

typeCode

property 
typeCode:uint  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates what type of association this is. Values are: Association.MANY or Association.ONE.



Implementation
    public function get typeCode():uint
Constructor Detail

ManagedAssociation

()Constructor
public function ManagedAssociation(info:XML = null)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructs an instance of metadata with the specified XML snippet that contains the relationship and service reference information.

Parameters
info:XML (default = null) — XML containing the association information.

Throws
ArgumentError — If required information is missing.
Method Detail

getAttributeMask

()method
public function getAttributeMask():uint

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Bit mask representing the attributes of this managed association. Starting with the smallest order bit: First bit - on when this association is lazy. Second bit - on when the association is loaded on demand. Third bit - on when the association is read only. Foruth bit - on when hierarchical events are enabled. Fifth bit - on when hierarchical events have been set. Sixth bit - on when updates are paged.

Returns
uint — bit mask representing the attributes of this managed association.

readExternal

()method 
public function readExternal(input:IDataInput):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Parameters

input:IDataInput

setAttributeMask

()method 
public function setAttributeMask(mask:uint):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Sets the attributes of this association based on the passed in bit mask. Starting with the smallest order bit: First bit - on when this association is lazy. Second bit - on when the association is loaded on demand. Third bit - on when the association is read only. Foruth bit - on when hierarchical events are enabled. Fifth bit - on when hierarchical events have been set. Sixth bit - on when updates are paged.

Parameters

mask:uint — bit mask representing the attributes of this managed association.

toString

()method 
public function toString():String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns the string representation of the specified object.

Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the override keyword. For example, a subclass of Object implements function toString():String instead of using an override of the base class.

Returns
String — A string representation of the object.

writeExternal

()method 
public function writeExternal(output:IDataOutput):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

This method will serialize this cache to the specified output stream. Currently this is being used for offline data caching.

Parameters

output:IDataOutput — output stream to write to.
Constant Detail

MANY

Constant
public static const MANY:uint = 0

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that this is a many-to-many or one-to-many relationship.

MANY_TO_MANY

Constant 
public static const MANY_TO_MANY:String = "many-to-many"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 4.5
Runtime Versions: Flash Player 10.1, AIR 2.0

Indicates that this is a many-to-many relationship.

MANY_TO_ONE

Constant 
public static const MANY_TO_ONE:String = "many-to-one"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 4.5
Runtime Versions: Flash Player 10.1, AIR 2.0

Indicates that this is a many-to-one relationship.

ONE

Constant 
public static const ONE:uint = 1

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 3
Runtime Versions: Flash Player 9, AIR 1.1

Indicates that this is a one-to-one relationship.

ONE_TO_MANY

Constant 
public static const ONE_TO_MANY:String = "one-to-many"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 4.5
Runtime Versions: Flash Player 10.1, AIR 2.0

Indicates that this is a one-to-many relationship.

ONE_TO_ONE

Constant 
public static const ONE_TO_ONE:String = "one-to-one"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Data Services for Java EE 4.5
Runtime Versions: Flash Player 10.1, AIR 2.0

Indicates that this is a one-to-one relationship.




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

 

Legal Notices | Online Privacy Policy