| Package | mx.rpc.soap |
| Class | public class Operation |
| Inheritance | Operation  AbstractOperation AbstractInvoker EventDispatcher Object |
| Subclasses | Operation |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
send() method.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | arguments : Object
The arguments to pass to the Operation when it is invoked. | AbstractOperation | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| endpointURI : String
The location of the WebService for this Operation. | Operation | ||
| forcePartArrays : Boolean
Determines whether or not a single or empty return value for an output
message part that is defined as an array should be returned as an array
containing one (or zero, respectively) elements. | Operation | ||
| headerFormat : String
Determines how the SOAP encoded headers are decoded. | Operation | ||
| headers : Array [read-only]
Accessor to an Array of SOAPHeaders that are to be sent on
each invocation of the operation. | Operation | ||
| httpHeaders : Object
Custom HTTP headers to be sent to the SOAP endpoint. | Operation | ||
| ignoreWhitespace : Boolean
Determines whether whitespace is ignored when processing XML for a SOAP
encoded request or response. | Operation | ||
| lastResult : Object [read-only]
The result of the last invocation. | AbstractInvoker | |
| makeObjectsBindable : Boolean [override]
When this value is true, anonymous objects returned are forced to
bindable objects. | Operation | ||
| multiplePartsFormat : String
Determines the type of the default result object for calls to web services
that define multiple parts in the output message. | Operation | ||
| name : String
The name of this Operation. | AbstractOperation | |
| operationManager : Function
This property is set usually by framework code which wants to modify the
behavior of a service invocation without modifying the way in which the
service is called externally. | AbstractInvoker | |
| properties : Object
This is a hook primarily for framework developers to register additional user
specified properties for your operation. | AbstractOperation | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| request : Object
The request of the Operation is an object structure or an XML structure. | Operation | ||
| resultElementType : Class
Like resultType, used to define the ActionScript class used by a given operation though
this property only applies to operations which return a multi-valued result (e.g. | AbstractInvoker | |
| resultFormat : String
Determines how the Operation result is decoded. | Operation | ||
| resultHeaders : Array [read-only]
The headers that were returned as part of the last execution of this
operation. | Operation | ||
| resultType : Class
Specifies an optional return type for the operation. | AbstractInvoker | |
| service : AbstractService [read-only]
Provides convenient access to the service on which the Operation
is being invoked. | AbstractOperation | |
| xmlSpecialCharsFilter : Function
Specifies a custom function used to escape XML special characters before
encoding any simple content. | Operation | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new Operation. | Operation | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
Adds a header that is applied only to this Operation. | Operation | ||
addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void
Adds a header that is applied only to this Operation. | Operation | ||
[override]
Cancels the last service invocation or an invokation with the specified ID. | Operation | ||
Clears the headers for this individual Operation. | Operation | ||
|
Sets the result property of the invoker to null. | AbstractInvoker | |
|
Dispatches an event into the event flow. | EventDispatcher | |
Returns a header if a match is found based on QName localName and URI. | Operation | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
Removes the header with the given QName from all operations. | Operation | ||
|
Executes the method. | AbstractOperation | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
This hook is exposed to update the lastResult property. | AbstractInvoker | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when an Operation call fails. | AbstractOperation | ||
| Dispatched when an Operation invocation returns with SOAP headers in the response. | Operation | |||
| Dispatched when an Operation invocation successfully returns. | AbstractOperation | ||
endpointURI | property |
endpointURI:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The location of the WebService for this Operation. Normally, the WSDL specifies the location of the services, but you can set this property to override that location for the individual Operation.
Implementation
public function get endpointURI():String public function set endpointURI(value:String):voidforcePartArrays | property |
forcePartArrays:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines whether or not a single or empty return value for an output message part that is defined as an array should be returned as an array containing one (or zero, respectively) elements. This is applicable for document/literal "wrapped" web services, where one or more of the elements that represent individual message parts in the "wrapper" sequence could have the maxOccurs attribute set with a value greater than 1. This is a hint that the corresponding part should be treated as an array even if the response contains zero or one values for that part. Setting forcePartArrays to true will always create an array for parts defined in this manner, regardless of the number of values returned. Leaving forcePartArrays as false will only create arrays if two or more elements are returned.
Implementation
public function get forcePartArrays():Boolean public function set forcePartArrays(value:Boolean):voidheaderFormat | property |
headerFormat:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines how the SOAP encoded headers are decoded. A value of
object specifies that each header XML node will be decoded
into a SOAPHeader object, and its content property will be
an object structure as specified in the WSDL document. A value of
xml specifies that the XML will be left as XMLNodes. A
value of e4x specifies that the XML will be accessible
using ECMAScript for XML (E4X) expressions.
Implementation
public function get headerFormat():String public function set headerFormat(value:String):voidheaders | property |
httpHeaders | property |
httpHeaders:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Custom HTTP headers to be sent to the SOAP endpoint. If multiple headers need to be sent with the same name the value should be specified as an Array.
Implementation
public function get httpHeaders():Object public function set httpHeaders(value:Object):voidignoreWhitespace | property |
ignoreWhitespace:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines whether whitespace is ignored when processing XML for a SOAP
encoded request or response. The default is true
and thus whitespace is 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):voidmakeObjectsBindable | property |
makeObjectsBindable:Boolean[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
When this value is true, anonymous objects returned are forced to bindable objects.
Implementation
override public function get makeObjectsBindable():Boolean override public function set makeObjectsBindable(value:Boolean):voidmultiplePartsFormat | property |
multiplePartsFormat:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines the type of the default result object for calls to web services that define multiple parts in the output message. A value of "object" specifies that the lastResult object will be an Object with named properties corresponding to the individual output parts. A value of "array" would make the lastResult an array, where part values are pushed in the order they occur in the body of the SOAP message. The default value for document- literal operations is "object". The default for rpc operations is "array". The multiplePartsFormat property is applicable only when resultFormat is "object" and ignored otherwise.
Implementation
public function get multiplePartsFormat():String public function set multiplePartsFormat(value:String):voidrequest | property |
request:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The request of the Operation is an object structure or an XML structure. If you specify XML, the XML is sent as is. If you pass an object, it is encoded into a SOAP XML structure.
Implementation
public function get request():Object public function set request(value:Object):voidresultFormat | property |
resultFormat:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines how the Operation result is decoded. A value of
object specifies that the XML will be decoded into an
object structure as specified in the WSDL document. A value of
xml specifies that the XML will be left as XMLNodes. A
value of e4x specifies that the XML will be accessible
using ECMAScript for XML (E4X) expressions.
Implementation
public function get resultFormat():String public function set resultFormat(value:String):voidresultHeaders | property |
resultHeaders:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The headers that were returned as part of the last execution of this
operation. They match up with the lastResult property and
are the same as the collection of headers that are dispatched
individually as HeaderEvents.
This property can be used as the source for data binding. When this property is modified, it dispatches the resultForBinding event.
Implementation
public function get resultHeaders():ArrayxmlSpecialCharsFilter | property |
xmlSpecialCharsFilter:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies a custom function used to escape XML special characters before encoding any simple content. Valid for all operations on the web service unless specifically overwritten on the operation level. If no function is provided, the defaults is whatever is set by the particular implementation of IXMLEncoder.
Implementation
public function get xmlSpecialCharsFilter():Function public function set xmlSpecialCharsFilter(value:Function):voidOperation | () | Constructor |
public function Operation(webService:AbstractService = null, name:String = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a new Operation. This is usually done directly by the MXML compiler or automatically by the WebService when an unknown operation has been accessed. It is not recommended that a developer use this constructor directly.
ParameterswebService:AbstractService (default = null) | |
name:String (default = null) |
addHeader | () | method |
public function addHeader(header:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds a header that is applied only to this Operation. The header can be provided in a pre-encoded form as an XML instance, or as a SOAPHeader instance which leaves the encoding up to the internal SOAP encoder.
Parameters
header:Object — The SOAP header to add to this Operation.
|
addSimpleHeader | () | method |
public function addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds a header that is applied only to this Operation.
Parameters
qnameLocal:String — the localname for the header QName
| |
qnameNamespace:String — the namespace for header QName
| |
headerName:String — Name of the header.
| |
headerValue:String — Value of the header.
|
cancel | () | method |
override public function cancel(id:String = null):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Cancels the last service invocation or an invokation with the specified ID. Even though the network operation may still continue, no result or fault event is dispatched.
Parameters
id:String (default = null) |
mx.rpc:AsyncToken — The AsyncToken associated with the call that is cancelled or null if no call was cancelled.
|
clearHeaders | () | method |
public function clearHeaders():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Clears the headers for this individual Operation.
getHeader | () | method |
public function getHeader(qname:QName, headerName:String = null):SOAPHeader| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a header if a match is found based on QName localName and URI.
Parameters
qname:QName — QName of the SOAPHeader.
| |
headerName:String (default = null) |
SOAPHeader — Returns the SOAPHeader.
|
removeHeader | () | method |
public function removeHeader(qname:QName, headerName:String = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes the header with the given QName from all operations.
Parameters
qname:QName — QName of the SOAPHeader.
| |
headerName:String (default = null) |
header | Event |
mx.rpc.events.HeaderEventproperty HeaderEvent.type =
mx.rpc.events.HeaderEvent.HEADER| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when an Operation invocation returns with SOAP headers in the response. A HeaderEvent is dispatched for each SOAP header.
The HEADER event type.The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
token | The token that represents the call to the method. Used in the asynchronous completion token pattern. |
cancelable | true, but the preventDefault() method has no effect. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
header | Header that the RPC call returns in the response. |
message | The Message associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Mon Nov 28 2011, 06:48 AM -08:00