There are a variety of execution methods. Some are always generated with every .NET proxy object, but others are only generated if one or both of the optional APIs are selected during generation. The following table lists the execution methods, when they are generated, and a summary of what each one does.
Some execution methods make use of a comCfg string. This string takes the same form as is provided in the commcfg.txt file, with the exception that it should not contain the trancode parameter.
For example, for a TCP/IP transport configuration a commcfg.txt 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.txt file, but without the trancode parameter at the beginning.
Each execution method is generated as a web method. Microsoft .NET Framework and IIS are able to transform these web methods into Web Services. See the Microsoft documentation for steps to transform .NET classes into web services.
|
Execution Method |
Comments |
|---|---|
|
execute(importView) |
Returns an exportView. This method performs a synchronous cooperative flow using the import data provided. It returns the export results and throws GenExceptions for any errors. |
|
execute(importView, String comCfg) |
Returns an exportView. This method performs a synchronous cooperative flow configured by the comCfg parameter using the import data provided. It returns the export results and throws GenExceptions for any errors. |
|
xmlExecute(String importView) |
(XML API only) Returns a string containing the export view data in XML format. This method performs a synchronous cooperative flow using the import data passed in XML format. It returns the export results and throws GenExceptions for any errors. |
|
xmlExecute(String importView, String comCfg) |
(XML API only) Returns a string containing the export view data in XML format. This method performs a synchronous cooperative flow configured by the comCfg parameter, with the import data passed in XML format. It returns the export results and throws GenExceptions for any errors. |
|
asyncExecute(importView) |
(Async API only) Returns an int containing the id used to retrieve the asynchronous results later. This method begins an asynchronous cooperative flow using the import data provided. It throws GenExceptions for any errors. |
|
asyncExecute(importView, boolean noResponse) |
(Async API only) Returns an int containing the id used to retrieve the asynchronous results later. This method begins an asynchronous cooperative flow using the import data provided. The noResponse parameter indicates to the runtime whether any results are expected back. It throws GenExceptions for any errors. |
|
asyncExecute(importView, boolean noResponse, String comCfg) |
(Async API only) Returns an int containing the id used to retrieve the asynchronous results later. This method begins an asynchronous cooperative flow using the import data provided. The noResponse parameter indicates to the runtime whether any results are expected back. It throws GenExceptions for any errors. |
|
asyncGetResponse(int id) |
(Async API only) Returns an exportView. This method retrieves the results of an asynchronous cooperative flow specified by the id provided. It returns the export results and throws GenExceptions for any errors. |
|
asyncGetResponse(int id, boolean block) |
(Async API only) Returns an exportView. This method retrieves the results of an asynchronous cooperative flow specified by the id provided. The call will block waiting for results if they are not available yet, depending on the block parameter. It returns the export results and throws GenExceptions for any errors. |
|
asyncCheckResponse(int id) |
(Async API only) Returns a FlowStatus enumeration. This method retrieves the status of an asynchronous cooperative flow specified by the id provided. It throws GenExceptions for any errors. |
|
asyncIgnoreResponse(int id) |
(Async API only) This method flags the results of an asynchronous cooperative flow as ignorable. Once ignored, the results become irretrievable. It throws GenExceptions for any errors (Flagging a flow as ignored lets the runtime clean up resources devoted to that flow). |
|
asyncXMLExecute(String importView) |
(Async API and XML API only) Returns an int containing the id used to retrieve the asynchronous results later. This method begins an asynchronous cooperative flow with the import data passed in XML format. It throws GenExceptions for any errors. |
|
asyncXMLExecute(String importView, boolean noResponse) |
(Async API and XML API only) Returns an int containing the id used to retrieve the asynchronous results later. This method begins an asynchronous cooperative with the import data passed in XML format. The noResponse parameter indicates the runtime if it expects any results back. It throws GenExceptions for any errors. |
|
asyncXMLGetResponse(int id) |
(Async API and XML API Only) Returns a string containing the export view data in XML format. This method retrieves the results of an asynchronous cooperative flow. It returns the export results and throws GenExceptions for any errors. |
|
asyncXMLExecute(String importView, boolean noResponse, String comCfg) |
(Async API and XML API Only) Returns an int containing the id used to retrieve the asynchronous results later. This method begins an asynchronous cooperative flow configured by the comCfg parameter, with the import data passed in XML format. The noResponse parameter indicates to the runtime whether any results are expected back. It throws GenExceptions for any errors. |
|
asyncXMLGetResponse(int id, boolean block) |
(Async API and XML API Only) Returns a string containing the export view data in XML format. This method retrieves the results of an asynchronous cooperative flow. The call blocks waiting for results if they are not available yet, depending on the block parameter. It returns the export results and throws GenExceptions for any errors. |
|
Copyright © 2015 CA Technologies.
All rights reserved.
|
|