Packagemx.rpc.remoting
Classpublic class Operation
InheritanceOperation Inheritance AbstractOperation Inheritance AbstractInvoker Inheritance flash.events.EventDispatcher
Subclasses Operation

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

An Operation used specifically by RemoteObjects. An Operation is 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.


Public Properties
 PropertyDefined By
  argumentNames : Array
An ordered list of the names of the arguments to pass to a method invocation.
Operation
 Inheritedarguments : Object
The arguments to pass to the Operation when it is invoked.
AbstractOperation
  concurrency : String
The concurrency for this Operation.
Operation
 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
  makeObjectsBindable : Boolean
[override] When this value is true, anonymous objects returned are forced to bindable objects.
Operation
 Inheritedname : 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
 Inheritedproperties : 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
 Inheritedservice : AbstractService
[read-only] Provides convenient access to the service on which the Operation is being invoked.
AbstractOperation
  showBusyCursor : Boolean
Whether this operation should show the busy cursor while it is executing.
Operation
Public Methods
 MethodDefined By
  
Operation(remoteObject:AbstractService = null, name:String = null)
Creates a new Operation.
Operation
  
cancel(id:String = null):AsyncToken
[override] Cancels the last service invocation or an invokation with the specified ID.
Operation
 Inherited
clearResult(fireBindingEvent:Boolean = true):void
Sets the result property of the invoker to null.
AbstractInvoker
  
send(... args):AsyncToken
[override] Executes the method.
Operation
 Inherited
setResult(result:Object):void
This hook is exposed to update the lastResult property.
AbstractInvoker
Events
 Event Summary Defined By
 Inherited
fault
Dispatched when an Operation call fails.AbstractOperation
 Inherited
result
Dispatched when an Operation invocation successfully returns.AbstractOperation
Property Detail
argumentNamesproperty
public var argumentNames:Array

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

An ordered list of the names of the arguments to pass to a method invocation. Since the arguments object is a hashmap with no guaranteed ordering, this array helps put everything together correctly. It will be set automatically by the MXML compiler, if necessary, when the Operation is used in tag form.

concurrencyproperty 
concurrency:String

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

The concurrency for this Operation. If it has not been explicitly set the setting from the RemoteObject will be used.


Implementation
    public function get concurrency():String
    public function set concurrency(value:String):void
makeObjectsBindableproperty 
makeObjectsBindable:Boolean[override]

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

When this value is true, anonymous objects returned are forced to bindable objects.


Implementation
    public function get makeObjectsBindable():Boolean
    public function set makeObjectsBindable(value:Boolean):void
showBusyCursorproperty 
showBusyCursor:Boolean

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

Whether this operation should show the busy cursor while it is executing. If it has not been explicitly set the setting from the RemoteObject will be used.


Implementation
    public function get showBusyCursor():Boolean
    public function set showBusyCursor(value:Boolean):void
Constructor Detail
Operation()Constructor
public function Operation(remoteObject: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 automatically by the RemoteObject when an unknown operation has been accessed. It is not recommended that a developer use this constructor directly.

Parameters
remoteObject:AbstractService (default = null) — The RemoteObject object defining the service.
 
name:String (default = null) — The name of the service.
Method Detail
cancel()method
override public function cancel(id:String = null):AsyncToken

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

Cancels the last service invocation or an invokation with the specified ID. Even though the network operation may still continue, no result or fault event is dispatched.

Parameters

id:String (default = null) — The messageId of the invocation to cancel. Optional. If omitted, the last service invocation is canceled.

Returns
AsyncToken — The AsyncToken associated with the call that is cancelled or null if no call was cancelled.
send()method 
override 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.



The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00