Print Page as PDF
xobw.error.SoapError ICR (5463)

xobw.error.SoapError    ICR (5463)

Name Value
NUMBER 5463
IA # 5463
DATE CREATED 2009/06/10
CUSTODIAL PACKAGE WEB SERVICES CLIENT
USAGE Supported
TYPE Other
DBIC APPROVAL STATUS APPROVED
NAME xobw.error.SoapError
GENERAL DESCRIPTION
class xobw.error.SoapError extends
xobw.error.AbstractError

Error class used by the HWSC error processing sub-system when a SOAP fault is
returned.
STATUS Active
DURATION Till Otherwise Agreed
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
code
property code As %String (TRUNCATE = 1)

Code associated with the error.
errorType
property errorType As %String (TRUNCATE = 1)

Human readable name for the type of error.
text
list property text As %String (TRUNCATE = 1)

Human readable text that provides information about the error.
soapFault
property soapFault As %SOAP.Fault

SOAP fault object instance returned by a web method call.
soapFaultType
property soapFaultType As %String (TRUNCATE = 1)
[Calculated;]

Type of SOAP fault returned by web method call. Possible types: - Server -
Client - Must Understand - Version Mismatch - Unknown
decompose
method decompose(ByRef error) returns nothing.

This method converts the error object properties into a traditional M array.
VARIABLES TYPE VARIABLES DESCRIPTION
error Both
pass by reference. error information is returned in
array nodes.

Structure of ARRAY returned ByRef:

ARRAY("errorType") = type of error (SOAP)
ARRAY("soapFaultType") = SOAP Fault Type
ARRAY("faultactor") = SOAP fault actor
ARRAY("faultcode") = SOAP fault code
ARRAY("faultstring") = SOAP fault string
ARRAY("detail") = SOAP fault detail
ARRAY("text") =
ARRAY("text",i..n) =
display
method display() returns nothing.

This method provides a simple display of the error using MUMPS WRITE commands.

Information displayed: - Class name - Properties:
- soapFaultType
- soapFault.faultactor
- soapFault.faultcode
- soapFault.faultstring
- soapFault.detail
isFaultClient
method isFaultClient() returns %String

Indicates if fault was produced when the client made an incorrect/incomplete
request.
VARIABLES TYPE VARIABLES DESCRIPTION
return value Output
evaluates to true if a client request fault, false if
not.
isFaultMustUnderstand
method isFaultMustUnderstand() returns %String

Indicates if fault was produced when a header was not handled by server when
the 'MustUnderstand' attribute was set to 'true'.
VARIABLES TYPE VARIABLES DESCRIPTION
return value Output
evaluates to true if fault was due to a header that
was not handled by the server with the MustUnderstand attribute set to true.
Otherwise evaluates to false.
isFaultServer
method isFaultServer() returns %String

Indicates if fault was produced when server side error occurred.
VARIABLES TYPE VARIABLES DESCRIPTION
return value Output
evaluates to true if fault was caused on server side,
otherwise evaluates to false.
isFaultVersionMismatch
method isFaultVersionMismatch() returns %String

Indicates if fault was produced when the SOAP versions between client and
server were incompatible.
VARIABLES TYPE VARIABLES DESCRIPTION
return value Output
evaluates to true if fault was due to SOAP version
incompatibility between server and client, otherwise evaluates to false.
soapFaultGet
method soapFaultGet() returns %SOAP.Fault

returns the SOAP fault object.
VARIABLES TYPE VARIABLES DESCRIPTION
return value Output
returns the SOAP fault object.
soapFaultTypeGet
method soapFaultTypeGet() returns %String

Returns text string describing type of fault.
VARIABLES TYPE VARIABLES DESCRIPTION
return value Output
Text description of the type of SOAP fault.

Server, Client, Version Mismatch, Must Understand, Unknown.
CREATOR CLARKE,KYLE E
DATE ACTIVATED 2009/06/17
MAIL MESSAGE 50288153
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF
2009/06/17 07:24 APPROVED CLARKE,KYLE
Generated from JAN 24, 2019@ IA Listing Descriptions