Skip to main content

%SOAP.Fault

Class %SOAP.Fault Extends (%RegisteredObject, %XML.Adaptor) [ Inheritance = right, Not ProcedureBlock, System = 3 ]

class to represent a SOAP fault. See schema at "http://schemas.xmlsoap.org/soap/envelope/" for details.

Parameters​

XMLIGNOREINVALIDTAG​

Parameter XMLIGNOREINVALIDTAG = 1;

XMLIGNORENULL​

Parameter XMLIGNORENULL = 1;

Properties​

faultcode​

Property faultcode As %String(MAXLEN = "");

The SOAP fault code as defined in the SOAP definition. Valid values are defined in %soap.inc: $$$FAULTVersionMismatch, $$$FAULTMustUnderstand, $$$FAULTClient and $$$FAULTServer.

faultstring​

Property faultstring As %String(MAXLEN = "");

faultactor​

Property faultactor As %String(MAXLEN = "");

faultPrefixDefinition​

Property faultPrefixDefinition As %String(MAXLEN = "", XMLPROJECTION = "NONE");

Optional prefix definition attribute to be added to Fault element. Usually of the form xmlns:prefix="namespace"

detail​

Property detail As %XML.String(MAXLEN = "");

XML element that gives error details. The contents of detail will not be escaped.

WSSecurityFault​

Property WSSecurityFault As %Boolean [ Internal ];

If true follow the WS-Security rules for converting SOAP 1.1 fault to SOAP 1.2 fault. The faultcode becomes the subCode and the faultcode becomes env:Sender

Methods​

AsString​

Method AsString() As %String

Return this SOAP fault as a string.