Previous Topic: Trace Control MethodsNext Topic: View Objects


Execution Methods

There are a variety of execution methods. Some are always generated with every Java 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:

Execution Method

Comments

Execute(importView)

Returns an exportView. This method performs a synchronous cooperative flow with the import data provided. It returns the export results and throws CSUExceptions for any errors.

Execute(importView, String comCfg)

Returns an exportView. This method performs a synchronous cooperative flow configured by the comCfg parameter, with the import data provided. It returns the export results and throws CSUExceptions 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 with the import data passed in XML format. It returns the export results and throws CSUExceptions 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 CSUExceptions 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 with the import data provided. It throws CSUExceptions 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 with the import data provided. The noResponse parameter indicates to the runtime whether any results are expected back. It throws CSUExceptions 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 with the import data provided. The noResponse parameter indicates to the runtime whether any results are expected back. It throws CSUExceptions for any errors.

AsyncGetReponse(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 CSUExceptions for any errors.

AsyncGetReponse(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 CSUExceptions for any errors.

AsyncCheckReponse(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 CSUExceptions for any errors.

AsyncIgnoreReponse(int id)

(Async API only)

This method flags the results of an asynchronous cooperative flow specified by the id provided as ignorable. Once ignored, the results become unretrievable. It throws CSUExceptions for any errors (Flagging a flow as ignored lets the runtime to 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 CSUExceptions 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 to the runtime whether any results are expected back. It throws CSUExceptions 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 CSUExceptions for any errors.

AsyncXMLGetReponse(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 specified by the id provided. The call blocks waiting for results if they are not available yet, depending on the block parameter. It returns the export results and throws CSUExceptions for any errors.

AsyncXMLGetReponse(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 specified by the id provided. It returns the export results and throws CSUExceptions for any errors.