RPCDataServiceAdapter - BETA ActionScript® 3 (AS3 LiveCycle Data Services) Reference for the Adobe® Flash® Platform API Reference

(Preview)

Package	mx.data
Class	public class RPCDataServiceAdapter
Inheritance	RPCDataServiceAdapter DataServiceAdapter Object

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

This is the abstract base class which you use to implement a new type of DataService implementation. Extend this class and override methods such as createItem, updateItem, etc. to customize how those calls are implemented. DataManagement will call these methods automatically as needed.

The trickiest thing about how this service works is that we want to take over the existing service's invocation so that user code is minimally impacted by the addition of data management. The service call works the same way, same events and tokens are fired only the result must be managed. To make this work, the RPCDataServiceAdapter associated a ManagedOperation with a regular RPC service operation. The operation's "operationManager" property is set and during initialization time and the end-user's call is redirected to a proxy method in this class (e.g. queryProxy). This generates the corresponding data management call and returns the managed token to the end user so they get the result of the managed operation.

 order is:
  user calls service method
     calls service delegates to operationManager - ManagedOpertion.xxProxy methods
        calls managerOperation kicks off DMS op --> DataManager.xx
           calls DMS op calls adapter to do the op --> DataServiceAdapter.invoke
              calls: RPCDataServiceAdapter invokes the service operation and sets the "raw" lastResult
              returns: adapter's result comes back in and is converted to DMS Result Message - RPCDataServiceResult.xxResult
        returns: data manager processes result - updates managed object --> DataListRequestResponder/CommitResponder
     returns: service is updated to lastResult from the operation
  returns: user's result event is called

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		asyncRequest : AsyncRequest [override] [read-only] An abstract method which returns an AsyncRequest that is used to handle all DataService operations.	RPCDataServiceAdapter
		connected : Boolean [read-only] Returns true when this service adapter is connected to its source.	DataServiceAdapter
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dataManagerRegistry : Object [static] Static map from destination name to data manager for that destination.	RPCDataServiceAdapter
		dataStore : DataStore Contains an object of type mx.data.DataStore.	DataServiceAdapter
		destination : String Name of destination for this data service adapter.	RPCDataServiceAdapter
		serializeAssociations : Boolean [override] [read-only] This controls whether or not DMS wraps the items into a serialization descriptor which excludes the associations.	RPCDataServiceAdapter
		throwUnhandledFaults : Boolean [override] [read-only] Returns false because this data manager does not throw an error if there is a fault with no listeners on the data manager.	RPCDataServiceAdapter

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		createItem(dataManager:RPCDataManager, item:Object):mx.rpc:AsyncToken This method is called by the RPCDataServiceAdapter when it needs to perform the createItem operation.	RPCDataServiceAdapter
		deleteItem(dataManager:RPCDataManager, item:Object):mx.rpc:AsyncToken This is called by the RPCDataServiceAdapter when the management layer wants to delete an item from the server.	RPCDataServiceAdapter
		executeQuery(dataManager:RPCDataManager, queryName:String, includeSpecifier:PropertySpecifier, queryArgs:Array):mx.rpc:AsyncToken Called when the adapter needs to execute a named query.	RPCDataServiceAdapter
		getConflictingProperties(dmgr:RPCDataManager, cause:DataMessage, serverObject:Object):Array Returns an array of property names that conflict between the client's version of an item and the server's version.	RPCDataServiceAdapter
		getDataManager(destination:String):DataManager [override]	RPCDataServiceAdapter
		getDataServiceAdapter(destination:String):DataServiceAdapter Looks up an associated data service adapter.	DataServiceAdapter
		getItem(dataManager:RPCDataManager, identity:Object, defaultValue:Object = null, includeSpecifier:PropertySpecifier = null):mx.rpc:AsyncToken Called to retrieve an individual item by identity from the adapter.	RPCDataServiceAdapter
		getItems(dataManager:RPCDataManager, ids:Array, includeSpecifier:PropertySpecifier):mx.rpc:AsyncToken Adapter method called when a list of items for a specific destination need to be fetched.	RPCDataServiceAdapter
		handleFault(errMsg:ErrorMessage, cause:DataMessage):void This gets called after we've finished processing a fault of a create, update, delete, or update collection operation.	RPCDataServiceAdapter
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		pageQuery(dataManager:RPCDataManager, queryName:String, queryArgs:Array, startIndex:int, numItems:int):mx.rpc:AsyncToken Perform a query for a single page of a client side query.	RPCDataServiceAdapter
		postItemDeletion(dataManager:RPCDataManager, identity:Object):void Simulate an event from the server that corresponds to an item delete.	RPCDataServiceAdapter
		postItemUpdate(dataManager:RPCDataManager, item:Object, origItem:Object = null, changes:Array = null):void Simulate an event from the server that corresponds to an item update or creation.	RPCDataServiceAdapter
		processDataMessage(msg:IMessage, responder:IResponder):void Low-level method used by the DataManager to processes a data message.	RPCDataServiceAdapter
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		startCheckForConflict(dmgr:RPCDataManager, cause:DataMessage, errMsg:ErrorMessage = null):void This gets called when we get a fault that might be a conflict from the server.	RPCDataServiceAdapter
		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.	Object
		updateCollection(dataManager:RPCDataManager, mq:ManagedQuery, ucmsg:UpdateCollectionMessage):mx.rpc:AsyncToken This is called when a collection managed by a query (not an association) has items added to the collection or removed from the collection.	RPCDataServiceAdapter
		updateItem(dataManager:RPCDataManager, item:Object, origItem:Object, changes:Array):mx.rpc:AsyncToken This method is called by the RPCDataServiceAdapter to perform a specific updateItem operation.	RPCDataServiceAdapter
		valueOf():Object Returns the primitive value of the specified object.	Object

Protected Methods

	Method		Defined By
		checkForConflict(resultEvent:ResultEvent, token:mx.rpc:AsyncToken):void This method gets called after a fault which might determine a conflict.	RPCDataServiceAdapter
		internalGetItem(dataManager:RPCDataManager, identity:Object, defaultValue:Object = null, includeSpecifier:PropertySpecifier = null):mx.rpc:AsyncToken This method actually performs the getItem operation but the result handler will not be used to update the managed result.	RPCDataServiceAdapter
		rpcAdapterFault(ev:FaultEvent, token:mx.rpc:AsyncToken):void Fault responder for RPCDataService operations.	RPCDataServiceAdapter
		sendResultEvent(token:mx.rpc:AsyncToken, msg:IMessage):void Success responder for RPCDataService operations.	RPCDataServiceAdapter

Property Detail

dataManagerRegistry

property

public static var dataManagerRegistry:Object

Static map from destination name to data manager for that destination.

destination

property

public var destination:String

Name of destination for this data service adapter.

Method Detail

getDataManager

()

method

override public function getDataManager(destination:String):DataManager

Parameters

destination:String

Returns

DataManager

postItemDeletion

()

method

public function postItemDeletion(dataManager:RPCDataManager, identity:Object):void

Simulate an event from the server that corresponds to an item delete. This is useful to notify LCDS that something has been deleted on the server.

Parameters

	`dataManager:RPCDataManager`

	`identity:Object`

postItemUpdate

()

method

 public function postItemUpdate(dataManager:RPCDataManager, item:Object, origItem:Object = null, changes:Array = null):void

Simulate an event from the server that corresponds to an item update or creation. This is useful to notify LCDS that something has changed on the server.

Parameters

	`dataManager:RPCDataManager`

	`item:Object`

	`origItem:Object` (default = `null`)

	`changes:Array` (default = `null`)

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

	`dataManager:RPCDataManager` — manager in control of the query operation to be invoked.

	`queryName:String` — query name

	`includeSpecifier:PropertySpecifier` — set of properties to be retrieved.

	`queryArgs:Array` — arguments to the query operation invocation.

	`dataManager:RPCDataManager` — associated data manager.

	`identity:Object` — identity of the item to be retrieved.

	`defaultValue:Object` (default = `null`) — [optional] An instance of the type with the default values that should be created if it doesn't exist.

	`includeSpecifier:PropertySpecifier` (default = `null`) — [optional] set of properties to be retrieved.

	`dataManager:RPCDataManager` — associated data manager.

	`identity:Object` — identity of the item to be retrieved.

	`defaultValue:Object` (default = `null`) — [optional] An instance of the type with the default values that should be created if it doesn't exist.

	`includeSpecifier:PropertySpecifier` (default = `null`) — [optional] set of properties to be retrieved.

	`dataManager:RPCDataManager` — manager in control of the query operation to be invoked.

	`queryName:String` — query name.

	`queryArgs:Array` — arguments to the query operation invocation.

	`startIndex:int` — start index for the page to be retrieved.

	`numItems:int` — size of page.

	`dataManager:RPCDataManager` — The data manager.

	`item:Object` — The new version of the item.

	`origItem:Object` — The original item.

	`changes:Array` — list of properties which to change.

RPCDataServiceAdapter - AS3 LiveCycle Data Services

Packagesx

Language Elements

Appendixes

Package mx.data

asyncRequest

dataManagerRegistry

destination

serializeAssociations

throwUnhandledFaults

checkForConflict

createItem

deleteItem

executeQuery

getConflictingProperties

getDataManager

getItem

getItems

handleFault

internalGetItem

pageQuery

postItemDeletion

postItemUpdate

processDataMessage

rpcAdapterFault

sendResultEvent

startCheckForConflict

updateCollection

updateItem

	`resultEvent:ResultEvent` — The event object from the `getItem()` call.

	`token:mx.rpc:AsyncToken` — Contains a `cause` property which is the original DataMessage for the change. This method can call `Conflicts.raiseConflict()` when there is a conflict, or it can do nothing if it determines there is no conflict.

	`dataManager:RPCDataManager` — manager in control of the create operation to be invoked.

	`item:Object` — item to be created.

	`dataManager:RPCDataManager` — manager in control of the delete operation to be invoked.

	`item:Object` — item to be deleted.

	`dmgr:RPCDataManager` — associated data manager.

	`cause:DataMessage` — data message whose processing may have triggered a conflict.

	`serverObject:Object` — the server's version of the item.

	`dataManager:RPCDataManager` — associated data manager.

	`ids:Array` — [optional] set of properties to be retrieved.

	`includeSpecifier:PropertySpecifier`

	`errMsg:ErrorMessage` — The description of the error.

	`cause:DataMessage` — The operation that caused the error.

	`msg:IMessage` — message to be processed.

	`responder:IResponder` — responder to be called back when the message processing completes.

	`ev:FaultEvent` — fault event received from the server.

	`token:mx.rpc:AsyncToken` — token associated with the invocation.

	`token:mx.rpc:AsyncToken` — token associated with the invocation.

	`msg:IMessage` — result message received from the server

	`dmgr:RPCDataManager` — the data manager associated with this adapter's destination.

	`cause:DataMessage` — original data message that may have potentially caused a conflict.

	`errMsg:ErrorMessage` (default = `null`) — the error message describing the fault associated with the conflict.

	`dataManager:RPCDataManager` — The data manager associated with this adapter's destination.

	`mq:ManagedQuery` — the managed query for which items have been added or removed.

	`ucmsg:UpdateCollectionMessage` — update collection message detailing the items that have been added or removed