Home > Class Reference > %SYS namespace > %SOAP.Fault

%SOAP.Fault

class %SOAP.Fault extends %Library.RegisteredObject, %XML.Adaptor

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

Property Inventory

Method Inventory

Parameters

parameter XMLIGNOREINVALIDTAG = 1;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties

property detail as %XML.String);
XML element that gives error details. The contents of detail will not be escaped.
Property methods: detailDisplayToLogical(), detailGet(), detailIsValid(), detailLogicalToDisplay(), detailLogicalToOdbc(), detailNormalize(), detailSet()
property faultPrefixDefinition as %String);
Optional prefix definition attribute to be added to Fault element. Usually of the form xmlns:prefix="namespace"
Property methods: faultPrefixDefinitionDisplayToLogical(), faultPrefixDefinitionGet(), faultPrefixDefinitionIsValid(), faultPrefixDefinitionLogicalToDisplay(), faultPrefixDefinitionLogicalToOdbc(), faultPrefixDefinitionNormalize(), faultPrefixDefinitionSet()
property faultactor as %String);
Property methods: faultactorDisplayToLogical(), faultactorGet(), faultactorIsValid(), faultactorLogicalToDisplay(), faultactorLogicalToOdbc(), faultactorNormalize(), faultactorSet()
property faultcode as %String);
The SOAP fault code as defined in the SOAP definition. Valid values are defined in %soap.inc: $$$FAULTVersionMismatch, $$$FAULTMustUnderstand, $$$FAULTClient and $$$FAULTServer.
Property methods: faultcodeDisplayToLogical(), faultcodeGet(), faultcodeIsValid(), faultcodeLogicalToDisplay(), faultcodeLogicalToOdbc(), faultcodeNormalize(), faultcodeSet()
property faultstring as %String);
Property methods: faultstringDisplayToLogical(), faultstringGet(), faultstringIsValid(), faultstringLogicalToDisplay(), faultstringLogicalToOdbc(), faultstringNormalize(), faultstringSet()

Methods

method AsString() as %String
Return this SOAP fault as a string.

Inherited Members

Inherited Methods