Packagemx.rpc
Classpublic class AbstractOperation
InheritanceAbstractOperation Inheritance AbstractInvoker Inheritance flash.events.EventDispatcher
Subclasses AbstractOperation, Operation, Operation

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The AbstractOperation class represents an individual method on a service. An Operation can be called either by invoking the function of the same name on the service or by accessing the Operation as a property on the service and calling the send() method.

See also

mx.rpc.AbstractService
mx.rpc.remoting.RemoteObject
mx.rpc.soap.WebService


Public Properties
 PropertyDefined By
  arguments : Object
The arguments to pass to the Operation when it is invoked.
AbstractOperation
 InheritedkeepLastResult : Boolean
Flag indicating whether the operation should keep its last call result for later access.
AbstractInvoker
 InheritedlastResult : Object
[read-only] The result of the last invocation.
AbstractInvoker
 InheritedmakeObjectsBindable : Boolean
When this value is true, anonymous objects returned are forced to bindable objects.
AbstractInvoker
  name : String
The name of this Operation.
AbstractOperation
 InheritedoperationManager : Function
This property is set usually by framework code which wants to modify the behavior of a service invocation without modifying the way in which the service is called externally.
AbstractInvoker
  properties : Object
This is a hook primarily for framework developers to register additional user specified properties for your operation.
AbstractOperation
 InheritedresultElementType : Class
Like resultType, used to define the ActionScript class used by a given operation though this property only applies to operations which return a multi-valued result (e.g.
AbstractInvoker
 InheritedresultType : Class
Specifies an optional return type for the operation.
AbstractInvoker
  service : AbstractService
[read-only] Provides convenient access to the service on which the Operation is being invoked.
AbstractOperation
Public Methods
 MethodDefined By
  
AbstractOperation(service:AbstractService = null, name:String = null)
Creates a new Operation.
AbstractOperation
 Inherited
cancel(id:String = null):AsyncToken
Cancels the last service invocation or an invokation with the specified ID.
AbstractInvoker
 Inherited
clearResult(fireBindingEvent:Boolean = true):void
Sets the result property of the invoker to null.
AbstractInvoker
  
send(... args):AsyncToken
Executes the method.
AbstractOperation
 Inherited
setResult(result:Object):void
This hook is exposed to update the lastResult property.
AbstractInvoker
Events
 Event Summary Defined By
  Dispatched when an Operation call fails.AbstractOperation
  Dispatched when an Operation invocation successfully returns.AbstractOperation
Property Detail
argumentsproperty
public var arguments:Object

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The arguments to pass to the Operation when it is invoked. If you call the send() method with no parameters, an array based on this object is sent. If you call the send() method with parameters (or call the function directly on the service) those parameters are used instead of whatever is stored in this property. For RemoteObject Operations the associated argumentNames array determines the order of the arguments passed.

nameproperty 
name:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The name of this Operation. This is how the Operation is accessed off the service. It can only be set once.


Implementation
    public function get name():String
    public function set name(value:String):void
propertiesproperty 
public var properties:Object

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

This is a hook primarily for framework developers to register additional user specified properties for your operation.

serviceproperty 
service:AbstractService  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Provides convenient access to the service on which the Operation is being invoked. Note that the service cannot be changed after the Operation is constructed.


Implementation
    public function get service():AbstractService
Constructor Detail
AbstractOperation()Constructor
public function AbstractOperation(service:AbstractService = null, name:String = null)

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Creates a new Operation. This is usually done directly by the MXML compiler or automatically by the service when an unknown Operation has been accessed. It is not recommended that a developer use this constructor directly.

Parameters
service:AbstractService (default = null) — The service on which the Operation is being invoked.
 
name:String (default = null) — The name of the new Operation.
Method Detail
send()method
public function send(... args):AsyncToken

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Executes the method. Any arguments passed in are passed along as part of the method call. If there are no arguments passed, the arguments object is used as the source of parameters.

Parameters

... args — Optional arguments passed in as part of the method call. If there are no arguments passed, the arguments object is used as the source of parameters.

Returns
AsyncToken — AsyncToken object. The same object is available in the result and fault events from the token property.
Event Detail
fault Event
Event Object Type: mx.rpc.events.FaultEvent
FaultEvent.type property = mx.rpc.events.FaultEvent.FAULT

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Dispatched when an Operation call fails.

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
ResultEvent.type property = mx.rpc.events.ResultEvent.RESULT

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Dispatched when an Operation invocation successfully returns.

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.