Skip to main content

%SOAP.Descriptor

Class %SOAP.Descriptor Extends (%RegisteredObject, %XML.Adaptor) [ Abstract, Inheritance = right, System = 3 ]

Super class for generated classes that represent WebMethods. Subclass %SOAP.MsgDescriptor is the super class for all Service WebMethods. Subclass %SOAP.ProxyDescriptor is the super class for all Client proxy WebMethods.
This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class."

Parameters​

NAMESPACE​

Parameter NAMESPACE [ Internal ];

NAMESPACE - specifies the XML namespace to be used for the XMLExport of the SOAP body's request and response messages. This parameter directly controls namespace usage by XMLExport.

SOAPBODYUSE​

Parameter SOAPBODYUSE [ Internal ];

SOAPBODYUSE - specifies SoapBodyUse keyword for this web method.

SOAPBINDINGSTYLE​

Parameter SOAPBINDINGSTYLE [ Internal ];

SOAPBINDINGSTYLE - specifies SoapBindingStyle keyword for this web method.

TYPENAMESPACE​

Parameter TYPENAMESPACE [ Internal ];

TYPENAMESPACE specifies the XML namespace for the types used for the method arguments and return types in this web client or web service when importing a SOAP message.

XMLIMPORTNAMESPACE​

Parameter XMLIMPORTNAMESPACE [ Internal ];

XMLIMPORTNAMESPACE specifies the XML namespace for the method definition in the WSDL for the web service when importing a SOAP message.

XMLELEMENT​

Parameter XMLELEMENT As BOOLEAN [ Internal ];

Specifies if part elements of messages in the WSDL use type or element attribute. XMLELEMENT defaults to 1 for "literal" WSDL and to 0 for "encoded" WSDL.

XMLRESULTNAME​

Parameter XMLRESULTNAME [ Internal ];

Name of result property

SOAPONEWAY​

Parameter SOAPONEWAY [ Internal ];

If = 1, then this is a one-way SOAP operation.

Methods​

GetSoapParameters​

ClassMethod GetSoapParameters(ByRef bindingStyle As %String, ByRef bodyUse As %String, ByRef namespace As %String, ByRef xmlimportnamespace As %String, ByRef typeNamespace As %String, ByRef oneWay As %Boolean, ByRef xmlelement As %Boolean, ByRef bare As %Boolean) [ Internal ]

Make the class parameters available a run time.

NeedsAdjustment​

ClassMethod NeedsAdjustment(ByRef ResultName As %String) As %Boolean [ CodeMode = generator, Internal, Private ]

Determine if the result element in a web client response needs to be adjusted to always match.

ImportSOAPMessage​

Method ImportSOAPMessage(messageName As %String, ResultName As %String, handler, message, messageChildlist, mimeAttachments As %Net.MIMEPart, checkRequired As %Boolean) As %Status [ Internal ]

Import the SOAP message -- request if a service and response if a client.