Packagemx.rpc.soap
Interfacepublic interface ISOAPEncoder extends IXMLEncoder

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An ISOAPEncoder is used to create SOAP 1.1 formatted requests for a web service operation. A WSDLOperation provides the definition of how a SOAP request should be formatted and therefore must be set before a call is made to encode().


Public Properties
 PropertyDefined By
  ignoreWhitespace : Boolean
Determines whether the encoder should ignore whitespace when constructing an XML representation of a SOAP request.
ISOAPEncoder
 InheritedstrictNillability : Boolean
When strictNillability is set to true, null values are encoded according to XML Schema rules (requires nillable=true to be set in the definition).
IXMLEncoder
  wsdlOperation : WSDLOperation
A WSDLOperation defines the SOAP binding styles and specifies how to encode a SOAP request.
ISOAPEncoder
 InheritedxmlSpecialCharsFilter : Function
The function to be used to escape XML special characters before encoding any simple content.
IXMLEncoder
Public Methods
 MethodDefined By
 Inherited
encode(value:*, name:QName = null, type:QName = null, definition:XML = null):XMLList
Encodes an ActionScript value as XML.
IXMLEncoder
  
encodeRequest(args:* = null, headers:Array = null):XML
Creates a SOAP-encoded request to an operation from the given input parameters and headers.
ISOAPEncoder
 Inherited
reset():void
Resets the encoder to its initial state, including resetting any Schema scope to the top level.
IXMLEncoder
Property Detail
ignoreWhitespaceproperty
ignoreWhitespace:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Determines whether the encoder should ignore whitespace when constructing an XML representation of a SOAP request. The default should be true and thus whitespace not preserved. If an XML Schema type definition specifies a whiteSpace restriction set to preserve then ignoreWhitespace must first be set to false. Conversely, if a type whiteSpace restriction is set to replace or collapse then that setting will be honored even if ignoreWhitespace is set to false.



Implementation
    public function get ignoreWhitespace():Boolean
    public function set ignoreWhitespace(value:Boolean):void
wsdlOperationproperty 
wsdlOperation:WSDLOperation

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A WSDLOperation defines the SOAP binding styles and specifies how to encode a SOAP request.



Implementation
    public function get wsdlOperation():WSDLOperation
    public function set wsdlOperation(value:WSDLOperation):void
Method Detail
encodeRequest()method
public function encodeRequest(args:* = null, headers:Array = null):XML

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Creates a SOAP-encoded request to an operation from the given input parameters and headers.

Parameters

args:* (default = null)
 
headers:Array (default = null)

Returns
XML



© 2009 Adobe Systems Incorporated. All rights reserved.
Sat Oct 3 2009, 04:15 AM -07:00