Packagecom.adobe.fiber.services.wrapper
Classpublic class AbstractServiceWrapper
InheritanceAbstractServiceWrapper Inheritance EventDispatcher Inheritance Object
Implements IMXMLObject
Subclasses HTTPServiceWrapper, RemoteObjectServiceWrapper, WebServiceWrapper

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

The AbstractServiceWrapper class is the super class of the hierarchy for generated service wrappers. As such it declares functions and variables common to all generated service wrappers. Sub classes include, HTTPServiceWrapper, RemoteObjectServiceWrapper, and WebServiceWrapper. Service wrappers are generated for correspondingly annotated services declared in models created by using the Adobe application modeling technology. They provide convenience in using the underlying services that they wrap.


Public Properties
 PropertyDefined By
  channelSet : ChannelSet
Channel set of the wrapped service.
AbstractServiceWrapper
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  destination : String
Destination of the wrapped service.
AbstractServiceWrapper
  operations : Object
Operations of the wrapped service.
AbstractServiceWrapper
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  serviceControl : AbstractService
[read-only] The wrapped service.
AbstractServiceWrapper
  showBusyCursor : Boolean
The showBusyCursor property of the wrapped service.
AbstractServiceWrapper
Public Methods
 MethodDefined By
  
AbstractServiceWrapper(target:IEventDispatcher = null)
Constructor.
AbstractServiceWrapper
 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
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
  
initialized(document:Object, id:String):void
Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.
AbstractServiceWrapper
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
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
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  
fault
Fault events of wrapped services are propagated by the wrapper.AbstractServiceWrapper
  
result
Result events of wrapped services are propagated by the wrapper.AbstractServiceWrapper
Property Detail
channelSetproperty
channelSet:ChannelSet

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

Channel set of the wrapped service.



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

See also

mx.rpc.AbstractService.channelSet
destinationproperty 
destination:String

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

Destination of the wrapped service.



Implementation
    public function get destination():String
    public function set destination(value:String):void

See also

mx.rpc.AbstractService.destination
operationsproperty 
operations:Object

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

Operations of the wrapped service.



Implementation
    public function get operations():Object
    public function set operations(value:Object):void

See also

mx.rpc.AbstractService.operations
serviceControlproperty 
serviceControl:AbstractService  [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():AbstractService
showBusyCursorproperty 
showBusyCursor:Boolean

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

The showBusyCursor property of the wrapped service.



Implementation
    public function get showBusyCursor():Boolean
    public function set showBusyCursor(value:Boolean):void
Constructor Detail
AbstractServiceWrapper()Constructor
public function AbstractServiceWrapper(target:IEventDispatcher = null)

Constructor.

Parameters
target:IEventDispatcher (default = null) — The target object for dispatched events.
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.rpc.events.FaultEvent
property FaultEvent.type = mx.rpc.events.FaultEvent.FAULT

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

Fault events of wrapped services are propagated by the wrapper.

The FAULT event type.

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.
faultThe Fault object that contains the details of what caused this event.
messageThe 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.
tokenThe token that represents the call to the method. Used in the asynchronous completion token pattern.
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 wrapped services are propagated by the wrapper.

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.



© 2009 Adobe Systems Incorporated. All rights reserved.
Sat Oct 3 2009, 04:15 AM -07:00