Exercise 3.4: Passing data to the server with the RemoteObject class

In this exercise, you will use the RemoteObject component to send data to a server to insert it into the database. You will also handle the confirmation message from the server to display in an alert dialog box (see Figure 1).

Remember that, in a previous exercise, you consolidated the form data in a value object and dispatched it from a custom component using a custom event.

In this exercise, you will learn how to:

• Create the RemoteObject instance
• Initialize the data transfer
• Use the Network Monitor to view
• Handle the result event

In this section you will create a RemoteObject instance that will be used to send information to the server.

1. Download the ex3_04_remote_starter.zip file if you haven't already and extract the ex3_04_remote_starter.fxp to your computer.
2. Open Flash Builder.
3. Import the ex3_04_remote_starter.fxp project file.
4. From the Package Explorer view, open the ex3_04_remote_starter.mxml file.
5. Within the Declarations block, below the RemoteObject instance, create another RemoteObject instance.

6. To the new RemoteObject instance, add the id property with a value of vehicleService, the destination property with a value of ColdFusion, the source property with a value of f4iaw100.remoteData.vehicleRequestData and the endpoint property with a value of http://adobetes.com/flex2gateway/.

Note: This example generates the XML using an Adobe ColdFusion server, but you can use any server to generate the XML file. Refer to the Flex and ColdFusion, PHP, Java, or .NET integration pages for more information.

7. Save the file.

In this section you will add the code to make the RemoteObject request and transfer the Form container data, as a value object dispatched from a custom component using a custom event, to the server.

1. Open the VehicleRequest.as file from the valueObjects package in the Package Explorer view.
2. Within the VehicleRequest.as file, above the VehicleRequest() class definition function, type [Rem to invoke the content assist tool and press Enter to insert the RemoteClass metadata tag into your code.
3. Place your cursor inside the closing bracket of the RemoteClass tag, type an opening parentheses and press Ctrl+Space to invoke the content assist tool. You should see the following:

4. Change the value of the alias property to f45iaw100.remoteData.VehicleRequest. This will map the VehicleRequest value object to the f45iaw100.remoteData.VehicleRequest Java object on the ColdFusion server.

5. Save the file.
6. Switch to the ex3_04_remote_starter.mxml file.
7. Locate the component:VehicleRequestForm instance below the Declarations block.
8. Note the vehicleRequestEvent property with a value of vehiclerequestform1_vehicleRequestEventHandler(event).

   The vehiclerequestform1_vehicleRequestEventHandler() function was created in Exercise 3.3 (Dispatching a value object from the custom component) to handle the vehicleRequestEvent custom event in the main application.

9. Within the Script block, locate the vehiclerequestform1_vehicleRequestEventHandler() function.
10. Within the function, delete the Alert.show() method.
11. Use the vehicleService.addVehicleRequest() method to pass the argument data set to the event.vehicleRequestData value.

    The vehicleService.addVehicleRequest() method references the addVehicleRequest() cffunction located in the employeeData.cfc that the RemoteObject component is calling. The addVehicleRequest() cffunction requires the argument data, which is why you have to send the event.vehicleRequestData value object using the data parameter.

12. Save the file.

Note: In order to complete this part of the exercise, you must have Flash Builder Premium Edition installed. If you have Flash Builder Standard Edition installed, skip this section and continue with the next section. If you want to download and install a trial version of Flash Builder Premium Edition, be sure to: 1) back up your existing workspace and projects; 2) uninstall Flash Builder Standard Edition; and then 3) install the trial version of Flash Builder Premium Edition. To compare the Standard Edition with the Premium Edition, check out the Upgrade Details page.

In this section you will use the Flash Builder Network Monitor to analyze the result of the vehicleService RemoteObject instance. 

1. For the vehicleService RemoteObject object, use the content assist tool to generate the result event (see Figure 2).

2. Use the content assist tool to generate a handler function for the result event (see Figure 3).

3. Within the Script block, locate the vehicleService_resultHandler() function and delete the generated code stub.
4. Save the file.
5. Open the Network Monitor.
6. Click the Enable Monitor button.
7. Run the application.
8. Select an employee, a pickup date and a return date, leave the Mobile Phone field empty and click Submit Request.

   You should see an error (see Figure 4).

9. Return to Flash Builder.
10. Double-click the Network Monitor tab to maximize it.
11. Select the addVehicleRequest operation (see Figure 5).

    Note the red circle with an X in it, signifying an error has occurred.

    Note: If the workspace you are using has multiple projects open, you may not see the recording in the Network Monitor. Close all other projects and enable the monitor again for your current project and make sure the message in the Network Monitor view reads, "Enabled for project 'ex3_04_remote_starter.'"

13. Locate the message that reads: Field 'VEHICLEREQUESTS.MOBILEPHONE' cannot be a zero-length string (see Figure 7).

Next, you will add a fault handler to show an Alert message when the Mobile Phone field is left blank.

14. Double-click the Network Monitor tab to minimize the view.
15. To the vehicleService RemoteObject object, add a fault event and, using the content assist tool, generate the fault handler.
16. Locate the vehicleService_faultHandler() method in the Script block and delete the generated code stub.
17. Within the function add the Alert.show() method to display the event.fault.faultString value as the text in the Alert pop-up.
18. Make the title of the alert message: Fault Information for addVehicleRequest.

19. Save the file.
20. Run the application.
21. Fill out everything except the Mobile Phone field in the form and click Submit Request.
22. You should see the alert message displayed (see Figure 8).

In this section you will use the RemoteObject component's result event and the addStatus value to determine if the value object has been successfully written to the data table on the server.

1. Locate the vehicleService_resultHandler() function.
2. Within the function, remove generated code and use content assist to insert a code template for an if statement.

3. Set the if statement to evaluate if the event.result.id value.

4. Within the if statement, use the Alert.show() method to display the text: The request was submitted. The record id is and add the event.result.id value.

5. Save the file.
6. Run the application.
7. From the DropDownList control, choose an employee.
8. In the Mobile Phone field, type 555-555-5555.
9. Choose a Pickup Date and a Return Date, then click the Submit Request button.

You should see the Alert window display the message that your request was submitted successfully and you should also see the record id (see Figure 9).

In this exercise, you learned how to use the RemoteObject component to send data to a server to insert it into the database. You also learned how to handle the confirmation message from the server to display an alert dialog box.