Binding a List Component to a Web Service Method

See Also

When you bind a list component to a web service, you create a connection between them. List components display one or more values at a time. For easiest data binding, use components from the Basic category of the Palette, such as Listbox, Drop Down List, Checkbox Group, or Radio Button Group.

After you add a web service to the IDE and to a page, you can call a web service?s method by using either of the following techniques:

• Bind a method to a component. You can use this technique to view the results of the method, but you cannot update it. You do not need to write any Java code.
   
  
• Call the method in your Java code. You can use this technique to view or update the web service.
   
  

The examples in the following procedures describe how to call the same web service method by using both techniques.

To bind a list component to a method:

1. If the web service is not part of the IDE, add the web service to the IDE.
    
   
2. Drag and drop the method onto the component.
    
   
3. Right-click the component and choose Bind to Data.
    
   
4. In the Bind to Data dialog box, click the Data Provider tab.
    
   
5. Choose the method?s data provider.
    
   
6. Select the value field and display field for the component.
    
   For example, consider the following scenario. You want to use the getPersons method of the TravelWS to display names in a drop-down list.
   1. Add the TravelWS.wsdl file shipped with the IDE.
       
      
   2. Drag the Basic > Dropdown List component to the page.
       
      
   3. Drag the getPersons method onto the drop-down list.
       
      
   4. Right-click the drop-down list and choose Bind to Data.
       
      
   5. Select personId for the value field and name for the display field.
       
      

To call a method in your Java code:

1. If the web service is not part of the IDE, add the web service to the IDE.
    
   
2. If the web service has not been added to the page, drag it to the Visual Designer.
    
   
3. If desired, select a method to see its properties in the Properties window.
    
   
4. If desired, test the web service?s methods by completing the following steps:
   1. Expand the web-service-name node.
       
      
   2. Right-click the method and choose Test Method.
       
      
   3. Type a test value for the parameters and click Submit.
       
      
   4. View the results and click Close.
       
      
   
    
   
5. Call the method in your Java code.
    
   For example, consider the following scenario. You want to use the getPersons method of the TravelWS web service to display names in a drop-down list.
   1. Add the TravelWS.wsdl file shipped with the IDE.
       
      
   2. Drag the Basic > Dropdown List component to the Visual Designer.
       
      
   3. Drag the getPersons method of TravelWS to the Visual Designer.
       
      
   4. In the Projects window, add a property named personOptions with the type ArrayList.
       
      
   • In the Projects window, expand project-name > Source Packages > web application-name.
      
     
   • Right-click Page1.java and choose Add > Property.
      
     
   • In the New Property Pattern dialog box, enter personOptions in the Name field and enter ArrayList in the Type drop-down list.
      
     
   5. Go to the Page1.java source code by selecting the Java tab.
       
      
   6. In the init() method, enter the following code:
       
      

   personOptions = new ArrayList();
   
           
   
    try {
   
        PersonDTO[] persons = travelWSClient1.getPersons();
   
        for( int i = 0; i < persons.length; i ++ ) 
   
            personOptions.add( new Option(new Integer(persons[i].getPersonId()), persons[i].getName() ) );
   
        
   
    }catch (Exception e) {
   
        log("Page1 Initialization Failure", e);
   
        throw e instanceof FacesException ? (FacesException) e: new FacesException(e);
   
    }

   7. Right-click in the Java Editor and choose Fix Imports.
       
      
   8. In the Fix Imports dialog box, choose com.sun.rave.web.ui.model.Option.
       
      
   9. Bind the new property to the drop-down list.
       
      
   • In the Visual Designer, right-click the drop-down list and choose Property Bindings.
      
     
   • In the right list in the Property Bindings dialog box, select Page 1 > personOptions.
      
     
   • Click Apply, then click Close.
      
     
   
    
   

See Also

About Web Services

Adding a Web Service to the IDE

Binding a Simple Component to a Web Service Method

Binding a Table Component to a Web Service Method

About the Projects and Files Windows

About the Java Editor