This builder creates a complete application based on a well-defined service.
To use this builder, your project must meet the following requirements.
- The project must be published and the application server must be running.
- The project must contain a service provider model that defines service operations.
The builder accesses the service operations and makes inputs available so that you can specify the user interface (for example, pages, links, and buttons).
In most common applications of this builder, these are the inputs you need.
- In the Data Service input, you identify the service that this builder is to use. This builder expects that you already have a Service Consumer builder in your model, and that the model points at a well-defined service, one with the logical operations defined. The service does not need to define all possible logical operations, but must define at least one logical operation.
For any operations that are defined, the correct Key Fields Required and Produced must be defined correctly. (RetrieveList and Search operations must each produce a key field. The RetrieveOne, Update, and Delete operations must each require a key field. The RetrieveList and Search operations may or may not have inputs. Update and Create operations are expected to have inputs (beyond the key field). If those operations do not have inputs, they are pretty meaningless. RetrieveOne and Delete operations are not expected to have any inputs beyond the key field, and any additional inputs are ignored.)
- In the Choose Pages / Operations input, you select the pages and operations to be created. Except for the details page, these choices are displayed only if the corresponding service is declared in the logical operations data.
The groups of inputs and the individual inputs are available based on your choices.
- The builder has the Use Theme input selected by default. This setting allows all the look and appearance of the user interface to be controlled by the default WebApp theme. If you do not select this input, all the HTML page and CSS inputs are available for you to specify the look and appearance of the application.
- The default arrangement of pages is that the filter page appears on the list page and the search results and search query pages are separate.
You can use the Filter on List Page input and the Put Query Page on Results Page input to change this condition.
- The builder implements the navigation from one page to another for all pages that it creates in the model.
You can use the Control All Navigation buttons input to control the buttons used for navigation.
Key objects that this builder creates
The builder creates all the pages to support the services available, and the methods to access those pages. It also generates the loop and counter variables. All these elements are created only if the associated page is created. All the elements are created with names based on the name that you supply in the builder Name
The builder creates a Java resource bundle for each displayed element in the model.
You can also have the builder generate methods to add and remove records if you do not want to supply the delete function from the search results page.
The following sample shows the use of the Data Services User Interface builder.
Parent topic: Builder help
About using the builder call editor