InterSystems IRIS Data Platform 2019.2  /  Class Definition Reference  /  Method Keywords

Class Definition Reference
Previous section           Next section
InterSystems: The power behind what matters   

Specifies the binding style or SOAP invocation mechanism used by this method, when it is used as a web method. Applies only in a class that is defined as a web service or web client.
To override the default binding style used by the method (when it is used as a web method), use the following syntax:
Method name(formal_spec) As returnclass [ WebMethod, SoapBindingStyle = soapbindingstyle ]  
{    //implementation }
Where soapbindingstyle is one of the following:
For a web service that you create manually, the default value of this keyword is usually suitable. When you generate a web client or service from a WSDL with the SOAP Wizard, InterSystems IRIS sets this keyword as appropriate for that WSDL; if you modify the value, your web client or service may no longer work.
This keyword lets you specify the binding style used by a web method. It affects the format of the SOAP body (but not any SOAP headers).
For a given method, this keyword overrides the SoapBindingStyle class keyword.
If you omit this keyword, the style attribute of <soap:operation> element is determined instead by the value for the SoapBindingStyle class keyword instead.
Relationship to WSDL
The SoapBindingStyle method keyword specifies the value of the style attribute of <soap:operation> element within the <binding> section of the WSDL. For example, if the SoapBindingStyle method keyword is document, the WSDL could look as follows:
<binding ...>
    <operation ...>
        <soap:operation ... style="document"/>
In contrast, if SoapBindingStyle is rpc, the WSDL could instead be as follows:
<binding ...>
    <operation ...>
        <soap:operation ... style="rpc"/>
The binding style also affects the request and response <message> elements for the web method, as follows:
Effect on SOAP Messages
For information, see the entry for the SoapBindingStyle class keyword.
Use with %XML.DataSet
If you use this keyword with a method that uses an object of type %XML.DataSet as input or output, some limitations apply. See the entry for the SoapBindingStyle class keyword.
See Also

Previous section           Next section
Send us comments on this page
View this book as PDF   |  Download all PDFs
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA
Content Date/Time: 2019-09-19 06:56:35