RPCDataManager

(Preview)

Package	mx.data
Class	public class RPCDataManager
Inheritance	RPCDataManager DataManager Object

Language Version:

ActionScript 3.0

Product Version:

LiveCycle Data Services for Java EE 3

Runtime Versions:

Flash Player 9, AIR 1.1

The RPCDataManager is a component you can use to manage objects which are retrieved using a service such as RemoteObject, WebService, and HTTPMultiService.

Default MXML Propertychildren

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		adapter : DataServiceAdapter = null An instance of a class that controls interaction with the server.	DataManager
		allowDynamicPropertyChangesWithCachedData : Boolean If false (default), then changing the item class dynamic properties when the local store is not empty causes an error fault when setItemClassDynamicProperties() is called.	RPCDataManager
		associations : Array Array of associations for this data manager's destination.	RPCDataManager
		autoCommit : Boolean Indicates whether changes to the local cache are automatically committed.	DataManager
		autoConnect : Boolean Indicates if this service should attempt to connect for any operations that require a connection.	DataManager
		autoMerge : Boolean If set to false, when changes are pushed from the remote destination to the client they are not immediately applied.	DataManager
		autoSaveCache : Boolean You can store the local cache of data and changes to disk.	DataManager
		autoSyncEnabled : Boolean [override] The RPCDataManager does not support the autoSync property.	RPCDataManager
		cacheID : String Provides access to the cache identifier for this service.	DataManager
		children : Array An array of associations and operations managed by this data manager.	RPCDataManager
		commitRequired : Boolean [read-only] Indicates if there are changes that have not been committed and the commit() method should be called.	DataManager
		conflictDetector : ConflictDetector Provides access to the current implementation being used to detect conflicts for remote operations pushed to this DataManager instance.	DataManager
		conflicts : Conflicts [read-only] Contains a Conflicts object, which is an ArrayList of Conflict instances.	DataManager
		connected : Boolean [read-only] Indicates if the DataService is connected to the remote destination.	DataManager
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dataStore : DataStore [override]	RPCDataManager
		deleteConflictMode : String = "none" Set this to 'object' to enable conflict detection on deleteItem() calls.	RPCDataManager
		deleteItemOnRemoveFromFill : Boolean By default, when you call the removeItemAt() method on a managed filled collection, it issues a delete item call to the server to physically remove the item.	DataManager
		destination : String The destination for the data service.	RPCDataManager
		encryptLocalCache : Boolean	DataManager
		extendsDestination : String Name of destination that the destination for this manager extends.	RPCDataManager
		fallBackToLocalFill : Boolean This flag determines whether the application should query against the local store when it is not connected.	DataManager
		hierarchicalEventsDefault : Boolean Associations optionally list property change events on properties of the associated instances.	DataManager
		identities : String For objects to be managed by a data manager, they must have one or more properties that uniquely identify them.	RPCDataManager
		identitiesArray : Array [read-only] Provides access to a list of the property names that combine to create a unique id for objects within the associated destination.	RPCDataManager
		ignoreCollectionUpdates : Boolean Indicates if changes to managed collections should be ignored instead of being communicated to the server on a commit.	DataManager
		indexReferences : Boolean To tune the speed of your application, set this property to false if you have a small number of fills or references to items managed by this DataManager from association properties of other items.	DataManager
		isInitialized : Boolean [read-only] Indicates whether the metadata associated with this DataManager instance is initialized.	DataManager
		itemClass : Class Specified the class of the objects managed by this data manager.	RPCDataManager
		itemClassDynamicProperties : Array [read-only] Returns the list of dynamic properties that are associated with the itemClass.	RPCDataManager
		managedOperations : Array The list of managed operations used for this data service.	RPCDataManager
		manualSync : ManualSyncConfiguration Provides access to the ManualSyncConfiguration instance for each DataManager instance.	DataManager
		maxFrequency : uint Determines the maximum number of messages per second the DataManager instance can receive.	DataManager
		mergeRequired : Boolean [read-only] Indicates whether there are any pending changes that must be merged.	DataManager
		offlineAdapter : DataServiceOfflineAdapter Returns an object of type mx.data.DataServiceOfflineAdapter.	DataManager
		operationsByName : Object Stores the name to ManagedOperation mapping for all ManagedOperation object.	RPCDataManager
		pageSize : int Provides access to the current page size setting for all collections.	DataManager
		pagingEnabled : Boolean [override] [read-only] The paging enabled setting is toggled at the query ManagedQuery level when the RPCDataManager is used.	RPCDataManager
		priority : int The default message priority for the messages the DataManager instance sends.	DataManager
		propertyNames : String When using anonymous types, you can specify the list of properties expected for an object.	RPCDataManager
		queries : Object Stores the name to ManagedQuery mapping for all ManagedQuery objects.	RPCDataManager
		requestTimeout : int Provides access to the request timeout in seconds for an operation.	DataManager
		resetCollectionOnFill : Boolean When the property is true, after the fill operation completes, a RESET event is sent.	DataManager
		resubscribeAttempts : int Controls the number of times a disconnected DataManager instance attempts to resubscribe to its destination.	DataManager
		resubscribeInterval : int Controls the delay, in milliseconds, between resubscribe attempts.	DataManager
		rpcAdapter : RPCDataServiceAdapter The RPCDataServiceAdapter defined for this data manager.	RPCDataManager
		service : AbstractService Each RPCDataManager is based on a single AbstractService implementation defined in this property.	RPCDataManager
		subscribed : Boolean [read-only] Indicates if the DataManager instance is subscribed to the remote destination.	DataManager
		throwItemPendingErrors : Boolean Set this property to false if you want to suppress item pending errors when lazily fetched or unpaged data is accessed.	DataManager
		typeProperty : String Property name of items being managed by this manager that specifies their owning destination.	RPCDataManager
		updateConflictMode : String = "none" Set this to 'object' or 'property' to enable conflict detection on updateItem() calls.	RPCDataManager

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		RPCDataManager() Constructs an instance of the data manager with the specified destination.	RPCDataManager
		addManagedOperation(mop:ManagedOperation):void Adds a managed operation to the set managed by this data manager.	RPCDataManager
		clearCache(value:Object = null):mx.rpc:AsyncToken Clears any data stored to disk with a previous call to the saveCache() method or when the autoSaveCache method was set to true	DataManager
		clearCacheData(descriptor:CacheDataDescriptor):mx.rpc:AsyncToken Clears the data specified by the passed descriptor from the local store.	DataManager
		commit(itemsOrCollections:Array = null, cascadeCommit:Boolean = false):mx.rpc:AsyncToken Commits pending changes for all collections currently managed by the DataStore instance associated with this DataManager instance.	DataManager
		commitRequiredOn(object:Object):Boolean Indicates if there are pending changes for this particular object.	DataManager
		connect():mx.rpc:AsyncToken Forces a connection attempt by this service to the remote destination.	DataManager
		count(... args):mx.rpc:AsyncToken Calls a count method on the remote destination.	DataManager
		createItem(item:Object):ItemReference Requests that the specified item be created in the remote store.	DataManager
		deleteItem(item:Object):mx.rpc:AsyncToken Requests that the specified item be deleted from the remote store.	DataManager
		disconnect():void Disconnects the DataManager instance's network connection.	DataManager
		executeQuery(queryName:String, propertySpecifier:PropertySpecifier, ... args):mx.rpc:AsyncToken Executes a query with the provided name and arguments.	DataManager
		fill(value:ListCollectionView, ... args):mx.rpc:AsyncToken Fills the specified ListCollectionView (collection) instance based on the associated fill method of the destination.	DataManager
		fillSubset(value:ListCollectionView, ps:PropertySpecifier, ... args):mx.rpc:AsyncToken Fills the specified ListCollectionView (collection) instance based on the associated fill method of the destination.	DataManager
		findItem(queryName:String, propertySpecifier:PropertySpecifier, ... args):mx.rpc:AsyncToken Executes a query that returns a single item.	DataManager
		getCacheData(descriptor:CacheDataDescriptor):mx.rpc:AsyncToken Returns an ArrayCollection or a single managed object from the the local store.	DataManager
		getCacheDescriptors(view:ListCollectionView, options:uint = 0, item:Object = null):mx.rpc:AsyncToken Fills the specified ListCollectionView (collection) instance with CacheDataDescriptor instances.	DataManager
		getCacheIDs(view:ListCollectionView):mx.rpc:AsyncToken Fills the specified ListCollectionView (collection) instance with all cache identifiers previously used in the application.	DataManager
		getItem(identity:Object, defaultValue:Object = null):ItemReference Makes an asynchronous request for an item matching the specified identity.	DataManager
		getLocalItem(identity:Object):Object Looks up the supplied item with the given identity.	DataManager
		getPageInformation(view:ListCollectionView):PageInformation Returns page information for the specified collection.	DataManager
		getPendingOperation(item:Object):uint Returns the pending operation in the message cache for the specified item.	DataManager
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialize():mx.rpc:AsyncToken [override] Forces initialization of the DataStore.	RPCDataManager
		isCollectionManaged(view:ListCollectionView):Boolean Returns true if the passed collection is managed by this service.	DataManager
		isCollectionPaged(view:ListCollectionView):Boolean Returns true if the passed collection is using paging features.	DataManager
		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
		isRangeResident(view:ListCollectionView, startIndex:int, numberOfItems:int):Boolean Returns true if the supplied range of items is all paged in.	DataManager
		localFill(value:ListCollectionView, ps:PropertySpecifier, ... args):mx.rpc:AsyncToken Fills the specified ListCollectionView based on the associated <fill-method> elements based on the data from the local store.	DataManager
		merge():void Merges any pending updates into the managed set of objects.	DataManager
		preInitialize():void Performs pre-initialization configuration steps.	RPCDataManager
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		refresh():mx.rpc:AsyncToken Refreshes all data managed by this DataManager instance.	DataManager
		refreshCollection(value:ListCollectionView):mx.rpc:AsyncToken Refreshes a collection previously filled with the fill method or managed as a managed association.	DataManager
		release(clear:Boolean = true, copyStillManagedItems:Boolean = true):void Releases all managed collections and items for the DataManager instance.	DataManager
		releaseCollection(view:ListCollectionView, clear:Boolean = false, copyStillManagedItems:Boolean = true):void Releases any item within the specified collection from management by this DataManager instance.	DataManager
		releaseItem(item:IManaged, copyStillManagedItems:Boolean = true, enableStillManagedCheck:Boolean = true):IManaged Releases the specified item from management by this DataManager instance.	DataManager
		releaseItemsFromCollection(collection:ListCollectionView, startIndex:int, numberOfItems:int):int Releases a range of items in the collection.	DataManager
		releaseReference(item:Object, propName:String):Boolean Releases the value for a single-valued association.	DataManager
		revertChanges(item:IManaged = null):Boolean Reverts any uncommitted changes to the specified item.	DataManager
		revertChangesForCollection(collection:ListCollectionView = null):Boolean Reverts the changes for any item contained in the specified collection which should be managed by this DataManager instance.	DataManager
		saveCache(value:Object = null):mx.rpc:AsyncToken This method saves the current state of the DataManager instance's cache.	DataManager
		setItemClassDynamicProperties(newProperties:Array):void Updates the list of dynamic properties that are associated with the itemClass.	RPCDataManager
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		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
		updateItem(item:Object, origItem:Object = null, changes:Array = null):mx.rpc:AsyncToken Triggers an update for the specified item.	DataManager
		valueOf():Object Returns the primitive value of the specified object.	Object

Protected Methods

	Method		Defined By
		checkImplementation():void [override] Queues a fault if this data manager has not yet been initialized.	RPCDataManager

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
conflict	The DataConflictEvent.CONFLICT event is dispatched when a conflict is detected between either pending local changes and changes submitted by another client, or when changes submitted by this client are conflicting with those in the remote destination.	RPCDataManager
fault	The DataServiceFaultEvent.FAULT event is dispatched when a service call fails due to an error.	RPCDataManager
message	The MessageEvent.MESSAGE event is dispatched when the remote destination pushes a notification of a data operation.	DataManager
propertyChange	The PropertyChangeEvent.PROPERTY_CHANGE event is dispatched when a property of this service changes.	RPCDataManager
result	The ResultEvent.RESULT event is dispatched when a service call successfully returns.	RPCDataManager

Property Detail

allowDynamicPropertyChangesWithCachedData

property

allowDynamicPropertyChangesWithCachedData:Boolean

If false (default), then changing the item class dynamic properties when the local store is not empty causes an error fault when setItemClassDynamicProperties() is called. If true, then the item class dynamic properties are changed in the metadata. The client programmer is then responsible for updating the local store as needed. For example, this.dataStore.localStore would give access to the SQLDBCache instance that can be manipulated as needed. NOTE: USE THIS AT YOUR OWN RISK!

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

associations

property

associations:Array

Array of associations for this data manager's destination.

Implementation
public function get associations():Array
public function set associations(value:Array):void

children

property

children:Array

An array of associations and operations managed by this data manager.

Implementation
public function get children():Array
public function set children(value:Array):void

dataStore

property

dataStore:DataStore[override]

Implementation
override public function get dataStore():DataStore
override public function set dataStore(value:DataStore):void

extendsDestination

property

public var extendsDestination:String

Name of destination that the destination for this manager extends. Null if the managed destination does not extend any destination.

itemClassDynamicProperties

property

itemClassDynamicProperties:Array [read-only]

Returns the list of dynamic properties that are associated with the itemClass.

Implementation
public function get itemClassDynamicProperties():Array

typeProperty

property

public var typeProperty:String

Property name of items being managed by this manager that specifies their owning destination.

Constructor Detail

Method Detail

checkImplementation

()

method

override protected function checkImplementation():void

Queues a fault if this data manager has not yet been initialized.

initialize

()

method

override public function initialize():mx.rpc:AsyncToken

Forces initialization of the DataStore.

Returns

mx.rpc:AsyncToken — AsyncToken reference to the token that will identify this operation in a result or fault event dispatched from this service.

setItemClassDynamicProperties

()

method

public function setItemClassDynamicProperties(newProperties:Array):void

Updates the list of dynamic properties that are associated with the itemClass. By default, the list can only be modified if the local cache is empty.

Parameters

newProperties:Array

Throws

Error — error if the local cache is not empty

Related API Elements

allowDynamicPropertyChangesWithCachedData

Event Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`conflict`	The Conflict object that holds the conflict that occurred.
`message`	The Message associated with this event.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Property	Value
`bubbles`	false
`cancelable`	true, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching this event
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`fault`	The Fault object that holds the conflict that occurred.
`item`	The item that generated the fault.
`identity`	The identity of of the item that generated the fault.
`message`	The Message associated with this event.
`token`	The token that represents the call to the method. Used in the asynchronous completion token pattern.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Property	Value
`bubbles`	Determined by the constructor; defaults to false.
`cancelable`	Determined by the constructor; defaults to false.
`kind`	The kind of change; PropertyChangeEventKind.UPDATE or PropertyChangeEventKind.DELETE.
`oldValue`	The original property value.
`newValue`	The new property value, if any.
`property`	The property that changed.
`source`	The object that contains the property that changed.
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Property	Value
`bubbles`	false
`cancelable`	true, preventDefault() from the associated token's responder.result method will prevent the service or operation from dispatching this event
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`message`	The Message associated with this event.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`result`	Result that the RPC call returns.
`token`	The token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern.

RPCDataManager - AS3 LiveCycle Data Services

Packagesx

Language Elements

Appendixes

Package mx.data

allowDynamicPropertyChangesWithCachedData

associations

autoSyncEnabled

children

dataStore

deleteConflictMode

destination

extendsDestination

identities

identitiesArray

itemClass

itemClassDynamicProperties

managedOperations

operationsByName

pagingEnabled

propertyNames

queries

rpcAdapter

service

typeProperty

updateConflictMode

addManagedOperation

checkImplementation

initialize

preInitialize

setItemClassDynamicProperties

conflict

fault

propertyChange

result