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 definitions in a ProcObject (optional)
 

Customizing method definitions in a ProcObject (optional)

For finer control, you can customize method definitions in a ProcObject.
To customize the definitions for methods included in a ProcObject according to your application requirements:
1. From the Customize Persistent Procedure dialog box, select an included internal procedure or user-defined function from the Internal Procedures/User-Defined Functions list.
2. Choose the Customize button.
The Customize Internal Procedure dialog box or the Customize User Defined Function dialog box appears, depending on the selection. This dialog box provides:
*A Procedure tab folder to modify the name and description of the method associated with the selected internal procedure or user-defined function.
*A Parameters tab folder to modify the behavior of any method parameters.
*A check box for internal procedures (Return ABL RETURN-VALUE) that specifies whether the procedure returns a string containing the value of the ABL RETURN-VALUE.
*A check box for user-defined functions (Enable Unknown Return Value) that specifies whether to enable clients to access the function return value as an object in order to return the ABL Unknown value (?) as a null. If not checked, and if available in the language, the client must use an intrinsic type for the return value that cannot represent the ABL Unknown value (?).
*A check box (Map Temp-Table Parameters to SQL ResultSets for Java) that 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.
*A check box (Use AppObject Unknown Setting) that specifies whether or not to use the AppObject or SubAppObject setting to indicate if all method parameters and return values enable passing of the ABL Unknown value (?) using objects to represent the Unknown value (?) as a null.
*A check box (Use AppObject Before-Image Setting), checked by default, that 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 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 the 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.
In the Procedure tab folder, you can:
*Rename the method (Method Name field)
*Enter descriptive information for the method (Description edit box)
In the Parameters tab folder, you can modify the behavior of method parameters. The tab has two sections listing the 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 that method. 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 as needed 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.