ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.collections 

ItemResponder  - AS3 Flex

Packagemx.collections
Classpublic class ItemResponder
InheritanceItemResponder Inheritance Object
Implements IResponder

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

The ItemResponder class provides a default implementation of the mx.rpc.IResponder interface. It represents a responder that lets you specify methods to be called when a request is completed, either successfully or with an error. The class object can also lets you provide data (a token) to be used by the responder methods.

You use an ItemResponder object in the catch statement of a try block that might result in getting remote data, as shown in the following code:


     import mx.collections.ItemResponder;
     //...
 
     try
     {
        //...
        cursor.moveNext();
     }
    catch(e:ItemPendingError)
     {
        e.addResponder(new ItemResponder(myResultFunction, myFaultFunction, {info:"..."}));
     }
  

The result method specified must have the following signature:

     public function myResultFunction(result:Object, token:Object = null):void;
  

The fault method specified must have the following signature:

     public function myFaultFunction(error:Object, token:Object = null):void;
  

Any other signature will result in a runtime error.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
ItemResponder(result:Function, fault:Function, token:Object = null)
Constructs an instance of the responder with the specified data and handlers.
ItemResponder
  
This method is called by a service when an error has been received.
ItemResponder
 Inherited
Indicates whether an object has a specified property defined.
Object
 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
  
This method is called by a service when the return value has been received.
ItemResponder
 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
Constructor Detail

ItemResponder

()Constructor
public function ItemResponder(result:Function, fault:Function, token:Object = null)

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

Constructs an instance of the responder with the specified data and handlers.

Parameters
result:Function — Function that should be called when the request has completed successfully. Must have the following signature:
	     		    public function (result:Object, token:Object = null):void;
	  		
 
fault:Function — Function that should be called when the request has completed with errors. Must have the following signature:
	     		    public function (error:ErrorMessage, token:Object = null):void;
	  		
 
token:Object (default = null) — Object [optional] additional information to associate with this request. This object is passed to the result and fault functions as their second parameter.
Method Detail

fault

()method
public function fault(info:Object):void

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

This method is called by a service when an error has been received.

Parameters

info:Object — Object containing the information about the error that occured.

result

()method 
public function result(data:Object):void

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

This method is called by a service when the return value has been received.

Parameters

data:Object — Object containing the information returned from the request.