Try OpenEdge Now
skip to main content
Open Client Introduction and Programming
Generating Proxies and Web Service Definitions : Defining procedures in AppObjects and SubAppObjects : Customizing method and ProcObject definitions (optional)
 

Customizing method and ProcObject definitions (optional)

For finer control, you can customize method and ProcObject definitions.
To customize method and ProcObject definitions for procedure files added according to your application requirements:
1. From the Procedures tab folder, select a procedure file in one of the lists.
2. Double-click the selection or choose Procedure > Customize from the menu bar.
This displays a dialog box that provides:
*A Procedure tab folder to modify the name and description of the associated method or ProcObject. In this folder, you can:
*Rename the method or ProcObject (Method Name or ProcObj Name field)
*Enter descriptive information for the method or ProcObject (Description field)
*A Parameters tab folder to modify the behavior of method or ProcObject parameters. The tab has two sections listing the procedure's parameters, one for customizing use of the Unknown value (?) and one for customizing use of ProDataSet before-image data. The dialog box populates each list with the parameters in the procedure. Deselecting either the Use AppObject Unknown Setting or Use AppObject Before-Image Setting check boxes enables the corresponding parameter list. You can then apply the setting to each specific parameter by selecting the check box beside it in the list.
Note: Not all settings apply to all the types of objects that ProxyGen can generate from the AppObject description. ProxyGen ignores any settings that do not apply to the client proxy that you specify at generation.
The Enable Unknowns list controls whether one or more method or ProcObject parameters enable passing of the ABL Unknown value (?) using objects to represent the Unknown value (?) as a null. If not checked, and if available in the language, the parameter uses an intrinsic type that cannot represent the ABL Unknown value (?). The Write XML Before-Images list controls whether a SOAP Web service includes before-image data for a ProDataSet parameter. Selecting the check box beside a ProDataSet includes the before-image data for that parameter.
*The Return ABL RETURN-VALUE check box specifies whether the procedure returns a string containing the value of the ABL RETURN-VALUE.
*The Map Temp-Table Parameters to SQL ResultSets for Java check box specifies whether to map temp-table parameters to Java SQL ResultSet or OpenEdge ProDataGraph objects for Java Open Clients. This check box is disabled and unchecked if one of the following is true:
*The Use AppObject Temp-Table Setting check box is checked.
*The procedure passes at least one ProDataSet parameter (with or without temp-table parameters). Any temp-table parameters must map to OpenEdge ProDataGraph objects.
*The procedure passes no ProDataSet or temp-table parameters.
*The Use AppObject Unknown Setting check box specifies whether to use the AppObject or SubAppObject setting to indicate if all parameters and return values enable passing of the ABL Unknown value (?) using objects to represent the Unknown value (?) as a null. For more information, see Specifying AppObject and SubAppObject definitions.
*The Use AppObject Before-Image Setting check box (checked by default) specifies whether to include ProDataSet before-image data in a SOAP Web service. For more information, see Specifying AppObject and SubAppObject definitions
*A check box (Use AppObject Temp-Table Setting), checked by default, that specifies whether or not to use the AppObject or SubAppObject setting to indicate if the procedure uses SQL ResultSet or OpenEdge ProDatGraph objects to map temp-table parameters for Java Open Clients. For more information, see Specifying AppObject and SubAppObject definitions. This check box is disabled and unchecked if one of the following is true:
*The procedure passes at least one ProDataSet parameter (with or without temp-table parameters). Any temp-table parameters must map to OpenEdge ProDataGraph objects
*The procedure passes no ProDataSet or temp-table parameters.
The Customize Persistent Procedure dialog box also has an Internal Procs tab folder to customize methods (internal procedures and user-defined functions) of the specified ProcObject. In the Internal Procs tab folder for ProcObjects (Customize Persistent Procedure dialog box), you can:
*Set check boxes to indicate whether one or more internal procedures or user-defined functions are included as methods of the ProcObject
*Customize the method definition for a selected internal procedure or user-defined function included in the ProcObject (Customize button)