Return data structure which indicates the success or failure of the method call. Return can contain three data members: returnCode, returnString, and soapid. For details, see The Return Object in the Subscribe API Guide.
Note: The examples in this guide do not contain error-handling. Your production applications, especially those that involve financial transactions, should always include robust error-checking and handling.
For Java, the SOAP call’s Return object is represented by the com.vindicia.client.VindiciaReturn object in the Java Subscribe client API.
For Java calls that are not expected to return a meaningful value (that is, if the call is expected to return a void value), the method usually returns a VindiciaReturn object instead of void. Examine the VindiciaReturn object for the returnCode, returnString, and soapid values.
For calls that are expected to return a meaningful value, the VindiciaReturn object can be a static member LAST_RETURN of the class of the object on which you made the call. For example, com.vindicia.client.AutoBill.fetchByEmail() returns an array of com.vindicia.client.AutoBill objects, that match the specified email address. If com.vindicia.client.AutoBill.fetchByEmail() does not return the expected values, check the VindiciaReturn object associated with the call. You can find the object in AutoBill.LAST_RETURN.
(The com.vindicia.client.AutoBill.cancel() call forms an exception to this rule, in that it returns a VindiciaReturn object.)
When a SOAP call returns multiple meaningful values (for example, AutoBill.update() returns the next billing amount, its currency, and the date in addition to the standard VindiciaReturn object), those values and the VindiciaReturn object are lumped into a single object that is returned by the corresponding Java method.
For instance, the com.vindicia.client.AutoBill.update() method returns a com.vindicia.client.AutoBillingReturn object, which lumps together all the return values of the underlying SOAP call.
Parent topic:Support for Development