(Adobe® Flex™ Data Services 2 only)
Packagemx.data.messages
Classpublic class DataAssociationMessage
InheritanceDataAssociationMessage Inheritance DataMessage Inheritance AsyncMessage Inheritance AbstractMessage Inheritance Object

This message is used to add and remove associations between objects managed by different data services. Associations are configured using the <metadata> tag in the destination configuration xml file.


Public Properties
 PropertyDefined by
 Inheritedbody : Object
The body of a message contains the specific data that needs to be delivered to the remote destination.
AbstractMessage
  childMessageId : String
If the association involves a child that is being created in the same message batch, the server will use this message id to locate the child instead of relying on the identity provided by the client (the identity may be changed by the server).
DataAssociationMessage
  childSequenceId : int
The index of the child sequence on the server.
DataAssociationMessage
 InheritedclientId : String
The clientId indicates which MessageAgent sent the message.
AbstractMessage
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcorrelationId : String
Provides access to the correlation id of the message.
AsyncMessage
 Inheriteddestination : String
The message destination.
AbstractMessage
 Inheritedheaders : Object
The headers of a message are an associative array where the key is the header name and the value is the header value.
AbstractMessage
 Inheritedidentity : Object
Provides access to the identity map which defines the unique identity of the item affected by this DataMessage (relevant for create/update/delete but not fill operations).
DataMessage
 InheritedmessageId : String
The unique id for the message.
AbstractMessage
 Inheritedoperation : uint
Provides access to the operation/command of this DataMessage.
DataMessage
  parentMessageId : String
If the association involves a parent that is being created in the same message batch, the server will use this message id to locate the parent instead of relying on the identity provided by the client (the identity may be changed by the server)
DataAssociationMessage
  parentPropertyName : String
The property name by which the parent references the child.
DataAssociationMessage
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  sequencePosition : int = -1
For one-to-many relationships, the position of the child instance in the sequence, optionally used for adding and removing child relationships to a specific location in the sequence.
DataAssociationMessage
 Inheritedtimestamp : Number
Provides access to the time stamp for the message.
AbstractMessage
 InheritedtimeToLive : Number
The time to live value of a message indicates how long the message should be considered valid and deliverable.
AbstractMessage
Public Methods
 MethodDefined by
  
DataAssociationMessage()
Creates a new instance of an empty association message.
DataAssociationMessage
 Inherited
getOperationAsString(op:uint):String
[static] Provides a description of the operation specified.
DataMessage
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
  
isCompensating(msg:DataAssociationMessage):Boolean
Determines whether the passed message is compensating to the current message.
DataAssociationMessage
 Inherited
isCreate():Boolean
Returns true if this is a create operation.
DataMessage
 Inherited
isEmptyUpdate():Boolean
Returns true if this message is both an update and its list of property names has a length of zero.
DataMessage
 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
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns a string representation of the message.
AbstractMessage
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
 InheritedASSOCIATION_ADD_OPERATION : uint = 13
[static] This operation requests the remote destination add a new association between the specified instances.
DataMessage
 InheritedASSOCIATION_REMOVE_OPERATION : uint = 14
[static] This operation requests the remote destination remove an association between the specified instances.
DataMessage
 InheritedBATCHED_OPERATION : uint = 5
[static] This operation represents a set of batched operations to be performed as a single unit.
DataMessage
 InheritedCOUNT_OPERATION : uint = 9
[static] This operation requests that a configured <count-method> be invoked on a remote destination.
DataMessage
 InheritedCREATE_AND_SEQUENCE_OPERATION : uint = 11
[static] This operation requests a create of the specified item from a remote destination.
DataMessage
 InheritedCREATE_OPERATION : uint = 0
[static] Indicates a create operation.
DataMessage
 InheritedDELETE_OPERATION : uint = 4
[static] This operation indicates that the specified item should be removed.
DataMessage
 InheritedDESTINATION_CLIENT_ID_HEADER : String = "DSDstClientId"
[static] Messages pushed from the server may arrive in a batch, with messages in the batch potentially targeted to different Consumer instances.
AbstractMessage
 InheritedENDPOINT_HEADER : String = "DSEndpoint"
[static] Messages are tagged with the endpoint id for the Channel they are sent over.
AbstractMessage
 InheritedFILL_OPERATION : uint = 1
[static] This operation requests that the remote destination create a sequence using the remote destination's adapter.
DataMessage
 InheritedGET_OPERATION : uint = 2
[static] This operation requests that the remote destination get a specific managed object based on its unique ID.
DataMessage
 InheritedGET_OR_CREATE_OPERATION : uint = 10
[static] This operation requests an item with the specified identity from the remote destination.
DataMessage
 InheritedGET_SEQUENCE_ID_OPERATION : uint = 12
[static] This operation requests a sequence id for a set of fill parameters.
DataMessage
 InheritedMULTI_BATCH_OPERATION : uint = 6
[static] This operation represents a set of operations to be performed as a single unit but which may contain multiple batched, create, update or delete operations that involve more than one destination, that is, more than one remote adapter.
DataMessage
 InheritedPAGE_ITEMS_OPERATION : uint = 20
[static] This operation indicates a request for a page of items specified by identities.
DataMessage
 InheritedPAGE_OPERATION : uint = 8
[static] This operation is used to retrieve a page of sequenced content that is delivered across several messages instead of in a single message.
DataMessage
 InheritedRELEASE_COLLECTION_OPERATION : uint = 18
[static] This operation indicates that the client is no longer interested in receiving notificaion of operations performed on the specified collection.
DataMessage
 InheritedRELEASE_ITEM_OPERATION : uint = 19
[static] This operation indicates that the client is no longer interested in receiving notification of operations performed on the specified item.
DataMessage
 InheritedREMOTE_CREDENTIALS_HEADER : String = "DSRemoteCredentials"
[static] Messages that need to set remote credentials for a destination carry the Base64 encoded credentials in this header.
AbstractMessage
 InheritedREQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout"
[static] Messages sent with a defined request timeout use this header.
AbstractMessage
 InheritedSUBTOPIC_HEADER : String = "DSSubtopic"
[static] Messages sent by a MessageAgent with a defined subtopic property indicate their target subtopic in this header.
AsyncMessage
 InheritedTRANSACTED_OPERATION : uint = 7
[static] This operation is similar to the MULTI_BATCH_OPERATION with the addition that the server should encapsulate the multiple batches of messages within a transacation.
DataMessage
 InheritedUNKNOWN_OPERATION : uint = 1000
[static] Code for an unknown operation type.
DataMessage
 InheritedUPDATE_BODY_CHANGES : uint = 0
[static] This constant is used to access the list of changed property names.
DataMessage
 InheritedUPDATE_BODY_NEW : uint = 2
[static] This constant is used to access the new value of a changed item.
DataMessage
 InheritedUPDATE_BODY_PREV : uint = 1
[static] This constant is used to access the previous value of the changed item.
DataMessage
 InheritedUPDATE_COLLECTION_OPERATION : uint = 17
[static] This operation is sent when a local or remote sequence has been modified by insert(s) or delete(s).
DataMessage
 InheritedUPDATE_OPERATION : uint = 3
[static] This operation indicates an update to data object has been performed.
DataMessage
Property detail
childMessageIdproperty
public var childMessageId:String

If the association involves a child that is being created in the same message batch, the server will use this message id to locate the child instead of relying on the identity provided by the client (the identity may be changed by the server).

childSequenceIdproperty 
public var childSequenceId:int

The index of the child sequence on the server.

parentMessageIdproperty 
public var parentMessageId:String

If the association involves a parent that is being created in the same message batch, the server will use this message id to locate the parent instead of relying on the identity provided by the client (the identity may be changed by the server)

parentPropertyNameproperty 
public var parentPropertyName:String

The property name by which the parent references the child.

sequencePositionproperty 
public var sequencePosition:int = -1

For one-to-many relationships, the position of the child instance in the sequence, optionally used for adding and removing child relationships to a specific location in the sequence.

Constructor detail
DataAssociationMessage()constructor
public function DataAssociationMessage()

Creates a new instance of an empty association message.

Method detail
isCompensating()method
public function isCompensating(msg:DataAssociationMessage):Boolean

Determines whether the passed message is compensating to the current message. An association add is compensating to a matching association remove, and vice versa.

Parameters
msg:DataAssociationMessage — The message to test against this message.

Returns
Boolean — true if the message is compensating; otherwise false.



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/data/messages/DataAssociationMessage.html