| Package | mx.rpc |
| Class | public class AbstractInvoker |
| Inheritance | AbstractInvoker  EventDispatcher Object |
| Subclasses | AbstractOperation, HTTPService |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| lastResult : Object [read-only]
The result of the last invocation. | AbstractInvoker | ||
| makeObjectsBindable : Boolean
When this value is true, anonymous objects returned are forced to bindable objects. | AbstractInvoker | ||
| operationManager : 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 | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| resultElementType : 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 | ||
| resultType : Class
Specifies an optional return type for the operation. | AbstractInvoker | ||
| Method | Defined By | ||
|---|---|---|---|
| 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 | |
Cancels the last service invocation or an invokation with the specified ID. | AbstractInvoker | ||
Sets the result property of the invoker to null. | AbstractInvoker | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
This hook is exposed to update the lastResult property. | AbstractInvoker | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
lastResult | property |
lastResult:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The result of the last invocation.
This property can be used as the source for data binding. When this property is modified, it dispatches the resultForBinding event.
Implementation
public function get lastResult():ObjectmakeObjectsBindable | property |
makeObjectsBindable:Boolean| 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):voidoperationManager | property |
public var operationManager:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. This allows you to add a "filter" step on the method call to ensure for example that you do not return duplicate instances for the same id or to insert parameters for performing on-demand paging. When this is set to a non-null value on the send call, the operationManager function is called instead. It returns the token that the caller uses to be notified of the result. Typically the called function will at some point clear this property temporarily, then invoke the operation again actually sending it to the server this time.
resultElementType | property |
public var resultElementType:Class| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. an Array or ArrayCollection (IList)). This property specifies an ActionScript class for the members of the array or array collection. When you set resultElementType, you do not have to set resultType. In that case, the operation returns an Array if makeObjectsbindable is false and an ArrayCollection otherwise.
resultType | property |
public var resultType:Class| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies an optional return type for the operation. Used in situations where you want to coerce the over-the-wire information into a specific ActionScript class or to provide metadata for other services as to the return type of this operation.
cancel | () | method |
public function cancel(id:String = null):mx.rpc: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) |
mx.rpc:AsyncToken — The AsyncToken associated with the call that is cancelled or null if no call was cancelled.
|
clearResult | () | method |
public function clearResult(fireBindingEvent:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the result property of the invoker to null.
This is useful when the result is a large object that is no longer being
used.
Parameters
fireBindingEvent:Boolean (default = true)true if you want anything
bound to the result to update. Otherwise, set to
false.
The default value is true
|
setResult | () | method |
public function setResult(result:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This hook is exposed to update the lastResult property. Since lastResult is ordinarily updated automatically by the service, you do not typically call this. It is used by managed services that want to ensure lastResult always points to "the" managed instance for a given identity even if the the service returns a new copy of the same object.
Parameters
result:Object — The new value for the lastResult property.
|
Mon Nov 28 2011, 06:48 AM -08:00