COM Proxy › COM Proxy Interface › Common Properties and Methods

Common Properties and Methods

The following properties and methods are common to all COM proxy classes:

• ClientId-Retrieves or sets the client user id property (String data type) to be sent to the server where the procedure steps executable code is installed. A client user id is usually accompanied by a client user password, which can also be set with the ClientPassword property. Security is not enabled until the security user exit is modified to enable it.
• ClientPassword-Retrieves or sets the client user password property (String data type), which is sent to the server where the procedure step executable code is installed. A client user password is usually accompanied by a client user id, which can also be set or retrieved with the ClientId property.
• CommandSent-Retrieves or sets the command sent property (String data type) to be sent to the server where the procedure step executable code is installed. This property should only be set if the procedure step uses case of command construct.
• ExitStateSent-Retrieves or sets the exit state property sent to the server procedure step. If the server does not use exit states, then the data type of this property is Long. Otherwise, the type of this property is the <component>ExitStates enumeration type that contains a value for each exit state with its name prefixed by the component name.

  This enumeration also contains a predefined value NONE prefixed by the component name with a value of zero that is the default exit state sent to the server if no ExitStateSent is specified. This property should be set only if the server procedure step refers the exit state sent to control its flow.

  Example (of a component EMPLOYEE with exit state PROCESSING_OK):

  Op.ExitStateSent = EmployeePROCESSING_OK
  

  Location-Retrieves or sets the location name (NEXTLOC) property (String data type) that can be used by ODC user exit flow dlls.

• CommandReturned-Retrieves the command returned property (read only String property), if any, after the server procedure step has been executed.
• ExitStateReturned-Read-only property containing the exit state returned from the server. If the procedure steps server uses exit states, then the type of this property is the <component>ExitStates enumeration type, as described in the ExitStateSent method description. Otherwise, the type is Long.
• OperationStatus-Read-only property that returns the operation status based on the server procedure step exit state. This type of property is an enumeration of the following constants:

Example (for a component with the name EMPLOYEE):

If Op.OperationStatus > EmployeeOk Then
MsgBox Op.OperationStatus & ": " & Op.OperationStatusMessage
End If

• OperationStatusMessage-Returns the status text message (read only String property), if one exists. A status message is associated with a status code, and can be returned by a CA Gen exit state.
• ServerLocation-Set this value to the name of the server where the remote <trancode>cm.dll has been installed.
• ComCfg-Set this value to the string value associated with the desired communications configuration. The string should take the form similar to the configuration string described in the commcfg.ini file, with the exception that it should not contain the trancode parameter. For example, for a TCP/IP transport configuration a commcfg.ini specification might be:

  tranX TCP hostname portNumber
  

  The corresponding ComCfg string would then be:

  TCP hostname portNumber
  

  Each supported transport has a slightly different communication string specification. In all cases the ComCfg string is expected to be the same as defined in the commcfg.ini file, but without the trancode parameter at the beginning. For more information, see the chapter “Overriding Communications Support at Execution Time” in the Distributed Processing - Overview Guide.

• Clear-This method clears all imports and exports attribute properties to their default values if one is specified in the model or otherwise to 0 for numeric, date and time attributes, empty string for string attributes and 00000000000000000000 for timestamp attributes.

  For attributes in repeating groups, the clear method sets the repeat count to 0. In addition to clearing attribute properties, the Clear method also clears the system property CommandReturned, ExitStateReturned, OperationStatus, and OperationStatusMessage.

• Execute-This method executes the server operation as a synchronous cooperative flow.
• ExecuteXML-Optional. This method executes the server operation as a synchronous cooperative flow. However, unlike the normal Execute method, it receives its input and returns its results as an XML stream.
• ExecuteAsync-Optional. This method executes the send portion of an asynchronous cooperative flow. An ID is returned containing a unique identifier that can then be used for retrieving the associated results. If no response is required, a parameter setting can indicate that no results are needed for this flow, allowing fire and forget processing.
• ExecuteAsyncXML-Optional. This method executes the send portion of an asynchronous cooperative flow. However, unlike the normal ExecuteAsync method, it receives its input as an XML stream. All other parameters behave similarly to the ExecuteAsync method.
• ExecuteGetResponse-Optional. This method executes the retrieve portion of an asynchronous cooperative flow. This method requires the ID of the associated request. It lets you specify whether the method should block or wait if the results are not immediately available.

  In a non-blocking situation, the method may return before the results have been processed. The result value indicates whether results have been processed. If they have been processed successfully, the export view area is populated with data, the transaction is considered complete, and the ID is no longer valid.

• ExecuteGetResponseXML-Optional. This method executes the receive portion of an asynchronous cooperative flow. However, unlike the normal ExecuteGetResponse method, it returns its output as an XML stream. All other parameters behave similarly to the ExecuteGetResponse method.
• ExecuteCheckResponse-Optional. This method checks the current status of an outstanding asynchronous request for a specific ID. The result value indicates whether the status is PENDING or AVAILABLE. There is a generated enumerated value for each proxy that can be checked. This is the same as performing an ExecuteGetResponse in a non-blocking mode, but usually executes many times faster due to less overhead.
• ExecuteIgnoreResponse-Optional. This method indicates the runtime that the application is no longer interested in the outstanding request, and that the results may be discarded. All asynchronous programs should either finish a request by retrieving the results or calling this method. The runtime can save processing time and memory if it is aware that the results are no longer required.