Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
com.adobe.fiber.services.wrapper 
DataServiceWrapper 
Packagecom.adobe.fiber.services.wrapper
Classpublic class DataServiceWrapper
InheritanceDataServiceWrapper Inheritance EventDispatcher Inheritance Object
Implements IMXMLObject

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

The DataServiceWrapper class is the superclass for generated service wrappers around DataService instances. Such service wrappers are generated for every entity in a model marked as LiveCycle Data Services backed. The wrapper provides convenience in using the underlying DataService class. The generated wrappers has individual, strongly typed functions corresponding to each fill (filter in the model) that the backing LiveCycle Data Services Data Management Service destination supports.



Public Properties
 PropertyDefined By
  channelSet : ChannelSet
The channelSet property of the wrapped service.
DataServiceWrapper
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  destination : String
[read-only] The destination of the wrapped service.
DataServiceWrapper
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  serviceControl : DataService
[read-only] The wrapped service.
DataServiceWrapper
Public Methods
 MethodDefined By
  
Constructs a wrapper around a DataService for a given destination.
DataServiceWrapper
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
  
Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.
DataServiceWrapper
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  Fault events of the wrapped data service are propagated by the wrapper.DataServiceWrapper
  Result events of the wrapped data service are propagated by the wrapper.DataServiceWrapper
Property Detail

channelSet

property
channelSet:ChannelSet

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

The channelSet property of the wrapped service.



Implementation
    public function get channelSet():ChannelSet
    public function set channelSet(value:ChannelSet):void

See also

destination

property 
destination:String  [read-only]

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

The destination of the wrapped service.



Implementation
    public function get destination():String

See also

serviceControl

property 
serviceControl:DataService  [read-only]

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

The wrapped service. The service is implemented by service specific subclasses.



Implementation
    public function get serviceControl():DataService
Constructor Detail

DataServiceWrapper

()Constructor
public function DataServiceWrapper(destination:String)

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructs a wrapper around a DataService for a given destination.

Parameters
destination:String — The name of the desired destination.

See also

Method Detail

initialized

()method
public function initialized(document:Object, id:String):void

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.

Parameters

document:Object — The MXML document that created this object.
 
id:String — The identifier used by document to refer to this object. If the object is a deep property on document, id is null.

Event Detail

fault

Event
Event Object Type: mx.data.events.DataServiceFaultEvent
property DataServiceFaultEvent.type = mx.data.events.DataServiceFaultEvent.FAULT

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Fault events of the wrapped data service are propagated by the wrapper. For details see DataService.fault.

The FAULT constant defines the value of the type property of the event object for a fault event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching this event
currentTargetThe 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.
targetThe 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.

See also

result

Event  
Event Object Type: mx.rpc.events.ResultEvent
property ResultEvent.type = mx.rpc.events.ResultEvent.RESULT

Language Version: ActionScript 3.0
Product Version: LiveCycle Data Services 3
Runtime Versions: Flash Player 9, AIR 1.1

Result events of the wrapped data service are propagated by the wrapper. For details see DataService.result.

The RESULT event type.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue, preventDefault() from the associated token's responder.result method will prevent the service or operation from dispatching this event
currentTargetThe 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.
targetThe 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.
resultResult that the RPC call returns.
tokenThe token that represents the indiviudal call to the method. Used in the asynchronous completion token pattern.

See also