Zimlet JavaScript API Reference - ZmCsfeResult

Class ZmCsfeResult


This class represents the result of a CSFE request. The data is either the response that was received, or an exception. If the request resulted in a SOAP fault from the server, there will also be a SOAP header present.

Defined in: ZmCsfeResult.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmCsfeResult(data, isException, header)
Creates a CSFE result object.
Method Summary
Method Attributes Method Name and Description
 
Gets the exception object, if any.
 
Gets the SOAP header that came with a SOAP fault.
 
Gets the response data.
 
Checks if this result is an exception.
 
set(data, isException, header)
Sets the content of the result.
Class Detail
ZmCsfeResult(data, isException, header)
Creates a CSFE result object.
Author: Conrad Damon.
Parameters:
{Object} data
the response data
{Boolean} isException
if true, the data is an exception object
{Object} header
the SOAP header
Method Detail
{ZmCsfeException} getException()
Gets the exception object, if any.
Returns:
{ZmCsfeException} the exception or null for none

{String} getHeader()
Gets the SOAP header that came with a SOAP fault.
Returns:
{String} the header

{Object} getResponse()
Gets the response data. If there was an exception, throws the exception.
Returns:
{Object} the data

{Boolean} isException()
Checks if this result is an exception.
Returns:
{Boolean} true if an exception

set(data, isException, header)
Sets the content of the result.
Parameters:
{Object} data
the response data
{Boolean} isException
if true, the data is an exception object
{Object} header
the SOAP header

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:30 GMT-0400 (EDT)