| Package | mx.data.messages |
| Class | public class UpdateCollectionMessage |
| Inheritance | UpdateCollectionMessage  DataMessage AsyncMessage AbstractMessage Object |
| 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 |
IListView.removeItemAt(), etc) or the
Single Managed Object API (DataService.createItem()).
The remote destination sends this message when the remote sequence is
updated and items are moved or removed and inserted.
This body property contains a list of
UpdateCollectionRange objects that indicate just how the
collection was modified.
Applying the update collection ranges inorder will establish a consistent
ordering of the items within the specified collection.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | body : Object
The body of a message contains the specific data that needs to be
delivered to the remote destination. | AbstractMessage | |
| clientId : String
The clientId indicates which MessageAgent sent the message. | AbstractMessage | |
| collectionId : Object
The unique identifier for the collection that was updated. | UpdateCollectionMessage | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| correlationId : String
Provides access to the correlation id of the message. | AsyncMessage | |
| destination : String
The message destination. | AbstractMessage | |
| headers : 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 | |
| identity : 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 | |
| messageId : String
The unique id for the message. | AbstractMessage | |
| operation : uint
Provides access to the operation/command of this DataMessage. | DataMessage | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| replace : Boolean
Indicates if the entire collection should be replaced by the contents
of this message. | UpdateCollectionMessage | ||
| timestamp : Number
Provides access to the time stamp for the message. | AbstractMessage | |
| timeToLive : Number
The time to live value of a message indicates how long the message
should be considered valid and deliverable. | AbstractMessage | |
| updateMode : int
Indicates the state of this update. | UpdateCollectionMessage | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of an empty UpdateCollectionMessage. | UpdateCollectionMessage | ||
| [static]
Provides a description of the operation specified. | DataMessage | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Returns true if this is a create operation. | DataMessage | |
|
Returns true if this message is both an update and its list
of property names has a length of zero. | DataMessage | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string representation of the message. | AbstractMessage | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| BATCHED_OPERATION : uint = 5 [static]
This operation represents a set of batched operations to be performed
as a single unit. | DataMessage | |
| CLIENT_UPDATE : int = 0 [static]
Indicates this update collection message was client generated. | UpdateCollectionMessage | ||
| COUNT_OPERATION : uint = 9 [static]
This operation requests that a configured <count-method> be
invoked on a remote destination. | DataMessage | |
| CREATE_AND_SEQUENCE_OPERATION : uint = 11 [static]
This operation requests a create of the specified item from a remote
destination. | DataMessage | |
| CREATE_OPERATION : uint = 0 [static]
Indicates a create operation. | DataMessage | |
| DELETE_OPERATION : uint = 4 [static]
This operation indicates that the specified item should be removed. | DataMessage | |
| DESTINATION_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 | |
| ENDPOINT_HEADER : String = "DSEndpoint" [static]
Messages are tagged with the endpoint id for the Channel they are sent over. | AbstractMessage | |
| FILL_OPERATION : uint = 1 [static]
This operation requests that the remote destination create a sequence
using the remote destination's adapter. | DataMessage | |
| FIND_ITEM_OPERATION : uint = 21 [static]
Like the FILL_OPERATION but ensures only a single item is returned in
the response array. | DataMessage | |
| FLEX_CLIENT_ID_HEADER : String = "DSId" [static]
This header is used to transport the global FlexClient Id value in outbound
messages once it has been assigned by the server. | AbstractMessage | |
| GET_OPERATION : uint = 2 [static]
This operation requests that the remote destination get a specific
managed object based on its unique ID. | DataMessage | |
| GET_OR_CREATE_OPERATION : uint = 10 [static]
This operation requests an item with the specified identity from the
remote destination. | DataMessage | |
| GET_SEQUENCE_ID_OPERATION : uint = 12 [static]
This operation requests a sequence id for a set of fill parameters. | DataMessage | |
| MULTI_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 | |
| PAGE_ITEMS_OPERATION : uint = 20 [static]
This operation indicates a request for a page of items specified by
identities. | DataMessage | |
| PAGE_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 | |
| PRIORITY_HEADER : String = "DSPriority" [static]
Messages sent by a MessageAgent can have a priority header with a 0-9
numerical value (0 being lowest) and the server can choose to use this
numerical value to prioritize messages to clients. | AbstractMessage | |
| RELEASE_COLLECTION_OPERATION : uint = 18 [static]
This operation indicates that the client is no longer interested in
receiving notification of operations performed on the specified collection. | DataMessage | |
| RELEASE_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 | |
| REMOTE_ALIAS : String = "flex.data.messages.DataMessage" [static]
Remote alias specifying the fully qualified server side class corresponding
to this class. | DataMessage | |
| REMOTE_CREDENTIALS_CHARSET_HEADER : String = "DSRemoteCredentialsCharset" [static]
Messages that need to set remote credentials for a destination
may also need to report the character-set encoding that was used to
create the credentials String using this header. | AbstractMessage | |
| REMOTE_CREDENTIALS_HEADER : String = "DSRemoteCredentials" [static]
Messages that need to set remote credentials for a destination
carry the Base64 encoded credentials in this header. | AbstractMessage | |
| REQUEST_TIMEOUT_HEADER : String = "DSRequestTimeout" [static]
Messages sent with a defined request timeout use this header. | AbstractMessage | |
| SERVER_OVERRIDE : int = 2 [static]
Indicates this update collection message was client generated and the
remote destination determined that it should be reverted on that client. | UpdateCollectionMessage | ||
| SERVER_UPDATE : int = 1 [static]
Indicates this update collection message was remotely generated and is
based on the current state of the remote sequence. | UpdateCollectionMessage | ||
| STATUS_CODE_HEADER : String = "DSStatusCode" [static]
A status code can provide context about the nature of a response
message. | AbstractMessage | |
| SUBTOPIC_HEADER : String = "DSSubtopic" [static]
Messages sent by a MessageAgent with a defined subtopic
property indicate their target subtopic in this header. | AsyncMessage | |
| SYNCHRONIZE_FILL_OPERATION : uint = 13 [static]
This operation requests that the remote destination create a sequence
using the remote destination's adapter. | DataMessage | |
| TRANSACTED_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 transaction. | DataMessage | |
| UNKNOWN_OPERATION : uint = 1000 [static]
Code for an unknown operation type. | DataMessage | |
| UPDATE_BODY_CHANGES : uint = 0 [static]
This constant is used to access the list of changed property names. | DataMessage | |
| UPDATE_BODY_NEW : uint = 2 [static]
This constant is used to access the new value of a changed item. | DataMessage | |
| UPDATE_BODY_PREV : uint = 1 [static]
This constant is used to access the previous value of the changed item. | DataMessage | |
| UPDATE_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 | |
| UPDATE_OPERATION : uint = 3 [static]
This operation indicates an update to data object has been performed. | DataMessage | |
Property Detail
collectionId | property |
public var collectionId:Object| 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 |
The unique identifier for the collection that was updated.
For a collection filled with the DataService.fill() method
this contains and Array of the parameters specified.
replace | property |
public var replace: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 if the entire collection should be replaced by the contents
of this message.
When the number of changes to a remote sequence have reached a tipping
point a replace message is generated as an optimization.
When true the body property contains an Array
of item identities that should replace any existing items.
updateMode | property |
public var updateMode:int| 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 the state of this update. The remote destination sends update collection messages to clients with one of three update modes:
UpdateCollectionMessage.SERVER_UPDATE- client applies this update collection unconditionallyUpdateCollectionMessage.CLIENT_UPDATE- the committing client does not need to process this update collection.UpdateCollectionMessage.SERVER_OVERRIDEN- the remote destination modified the update collection message sent by the client and the committing client must revert this update collection.
Constructor Detail
UpdateCollectionMessage | () | Constructor |
public function UpdateCollectionMessage()| 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 |
Creates a new instance of an empty UpdateCollectionMessage.
Constant Detail
CLIENT_UPDATE | Constant |
public static const CLIENT_UPDATE: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 |
Indicates this update collection message was client generated.
Related API Elements
SERVER_OVERRIDE | Constant |
public static const SERVER_OVERRIDE:int = 2| 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 this update collection message was client generated and the remote destination determined that it should be reverted on that client. A subsequent update collection message will follow containing the correct values to apply getting the client collection back to a consistent state with the remote one.
Related API Elements
SERVER_UPDATE | Constant |
public static const SERVER_UPDATE:int = 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 this update collection message was remotely generated and is based on the current state of the remote sequence.
Related API Elements
Mon Nov 28 2011, 06:48 AM -08:00