DataMessage  - AS3 LiveCycle Data Services

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

Provides access to the operation/command of this DataMessage. Operations indicate how the remote destination should process this message. To display a description of operation type use the getOperationAsString method.

Related API Elements

Constructor.

Provides a description of the operation specified. This method is used in toString() operations on this message.

Parameters

         var msg:DataMessage = DataMessage(event.message);
         trace("Current operation -'"+
                DataMessage.getOperationAsString(msg.operation)+ "'.");
      

Returns true if this is a create operation.

Related API Elements

Returns true if this message is both an update and its list of property names has a length of zero.

This operation represents a set of batched operations to be performed as a single unit. Clients send a batch when DataManager.commit() is invoked. All messages in the batch are intended for the same destination. The body property contains all of the messages that belong within this batch.

This operation requests that a configured <count-method> be invoked on a remote destination. The body property of the message will contain the arguments that should be passed to the remote destination when invoking the method. Clients send this operation when the DataManager.count() method is invoked.

Related API Elements

This operation requests a create of the specified item from a remote destination. Clients send this operation when the DataManager.createItem() method is invoked. The body property contains the item that should be created.

Related API Elements

Indicates a create operation. The body property will contain the new item to be created. When the operation is perfomed outside of an association a corresponding UpdateCollectionMessage is delivered indicating the location/index the item should be added at. Clients will send this operation when a collection under managemenet of a DataService uses the IList.addItemAt(), IList.addItem() or IViewCursor.insert() methods.

Related API Elements

This operation indicates that the specified item should be removed. Clients will receive and send this operation when the item is removed. Clients will send this operation when DataManager.deleteItem() or when a collection under managemenet of a data manager uses the IList.removeItemAt() or IViewCursor.remove() method.

Related API Elements

This operation requests that the remote destination create a sequence using the remote destination's adapter. The body property of the message will contain the fill arguments that should be used when creating the remote sequence.

Like the FILL_OPERATION but ensures only a single item is returned in the response array.

This operation requests that the remote destination get a specific managed object based on its unique ID. The identity property contains the desired object's identity.

Related API Elements

This operation requests an item with the specified identity from the remote destination. If no item exists with the identity, a create operation will be performed. Clients send this operation when the DataManager.getItem() method is called with non-null default values for the item. The body property contains the default values of the item should it need to be created.

Related API Elements

This operation requests a sequence id for a set of fill parameters. If the sequence exists, it will not be recreated. If it does not exist, it will be recreated remotely. Clients send this operation when reconnecting to a remote destination or when failing over to a new node within a cluster. This operation is only used if the fetch attribute of the <reconnect> tag in the remote destination's configuration XML file is set to IDENTITY.

Related API Elements

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. Clients send a multi-batch when DataManager.commit() is invoked and there are associations configured for that destination. Messages in this batch will be sent to multiple destinations.

This operation indicates a request for a page of items specified by identities. This is operation is similar to a PAGE_OPERATION except the page index is not needed. Clients send this operation when fetching lazily loaded items for associations configured using one-to-many and many-to-many.

This operation is used to retrieve a page of sequenced content that is delivered across several messages instead of in a single message. It represents a request for a portion of a remote sequence. Clients send this operation when an item or property is requested that is not resident locally. This operation is only performed if either the <paging> tag under <network> tag has its enabled attribute set to true with a non-zero pageSize attribute or if an association is configured with the lazy attribute set to true.

This operation indicates that the client is no longer interested in receiving notification of operations performed on the specified collection. Clients send this operation when DataManager.releaseCollection() is invoked or if DataManager.fill() is invoked with an ArrayCollection which was previously filled with different parameters or if a one-to-many association's owning item is released.

Related API Elements

This operation indicates that the client is no longer interested in receiving notification of operations performed on the specified item. Clients send this operation when DataService.releaseItem() or ItemReference.releaseItem() is invoked.

Related API Elements

Remote alias specifying the fully qualified server side class corresponding to this class.

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. This operation is only performed when the remote destination has the <use-transactions> tag under the <properties> tag within the destination configuration xml set with a value of true

Code for an unknown operation type.

This constant is used to access the list of changed property names. Use this property with bracket notation on the body property of a message with an operation of UPDATE_OPERATION.

Related API Elements

         var msg:DataMessage = DataMessage(event.message);
         if (msg.operation == DataMessage.UPDATE_OPERATION)
         {
            // look at each change and display the old and new values
            var propertyNames:Array = msg.body[DataMessage.UPDATE_BODY_CHANGES];
            var newValues:Object = msg.body[DataMessage.UPDATE_BODY_NEW];
            var oldValues:Object = msg.body[DataMessage.UPDATE_BODY_PREV];
            var propertyName:String;
            for (var i:int=0; i<propertyNames.length; i++)
            {
                propertyName = propertyNames[i];
                trace("Property '"+ propertyName + "' was changed from '" +
                      oldValues[propertyName] + "' to '"+ newValues[propertyName] +
                      "'.");
            }
         }
      

This constant is used to access the new value of a changed item. Use this property with bracket notation on the body property of a message with an operation of UPDATE_OPERATION.

Related API Elements

         var msg:DataMessage = DataMessage(event.message);
         if (msg.operation == DataMessage.UPDATE_OPERATION)
         {
            // look at each change and display the old and new values
            var propertyNames:Array = msg.body[DataMessage.UPDATE_BODY_CHANGES];
            var newValues:Object = msg.body[DataMessage.UPDATE_BODY_NEW];
            var oldValues:Object = msg.body[DataMessage.UPDATE_BODY_PREV];
            var propertyName:String;
            for (var i:int=0; i<propertyNames.length; i++)
            {
                propertyName = propertyNames[i];
                trace("Property '"+ propertyName + "' was changed from '" +
                      oldValues[propertyName] + "' to '"+ newValues[propertyName] +
                      "'.");
            }
         }
      

This constant is used to access the previous value of the changed item. Use this property with bracket notation on the body property of a message with an operation of UPDATE_OPERATION.

Related API Elements

         var msg:DataMessage = DataMessage(event.message);
         if (msg.operation == DataMessage.UPDATE_OPERATION)
         {
            // look at each change and display the old and new values
            var propertyNames:Array = msg.body[DataMessage.UPDATE_BODY_CHANGES];
            var newValues:Object = msg.body[DataMessage.UPDATE_BODY_NEW];
            var oldValues:Object = msg.body[DataMessage.UPDATE_BODY_PREV];
            var propertyName:String;
            for (var i:int=0; i<propertyNames.length; i++)
            {
                propertyName = propertyNames[i];
                trace("Property '"+ propertyName + "' was changed from '" +
                      oldValues[propertyName] + "' to '"+ newValues[propertyName] +
                      "'.");
            }
         }
      

This operation is sent when a local or remote sequence has been modified by insert(s) or delete(s). This operation provides information about the locations of all insert(s) and delete(s) such that the state of the collection order can be restored.

The body contains an Array of UpdateCollectionRanges indicating what items have been removed and added. Applying the update collection ranges in order will establish a consistent ordering of the items within the specified collection.

This operation indicates an update to data object has been performed. Clients will receive and send this operation when an item has been updated.

The body property of the message is an Array containing specific information about the update that occured. The DataMessage.UPDATE_BODY_CHANGES location within the array contains an array of property names that were changed during the update.

The DataMessage.UPDATE_BODY_NEW location within the array contains the object in its new modified state. The DataMessage.UPDATE_BODY_PREV location within the array contains the object in its state prior to the updates.

         var msg:DataMessage = DataMessage(event.message);
         if (msg.operation == DataMessage.UPDATE_OPERATION)
         {
            // look at each change and display the old and new values
            var propertyNames:Array = msg.body[DataMessage.UPDATE_BODY_CHANGES];
            var newValues:Object = msg.body[DataMessage.UPDATE_BODY_NEW];
            var oldValues:Object = msg.body[DataMessage.UPDATE_BODY_PREV];
            var propertyName:String;
            for (var i:int=0; i<propertyNames.length; i++)
            {
                propertyName = propertyNames[i];
                trace("Property '"+ propertyName + "' was changed from '" +
                      oldValues[propertyName] + "' to '"+ newValues[propertyName] +
                      "'.");
            }
         }