An Operation used specifically by WebServices. An Operation is an individual
method on a service. An Operation can be called either by invoking the
function of the same name on the service or by accessing the Operation as a
property on the service and calling the send() method.
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 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.
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.
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):void
forcePartArrays
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):void
headerFormat
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):void
headers
property
headers:Array [read-only]
Language Version :
ActionScript 3.0
Product Version :
Flex 3
Runtime Versions :
Flash Player 9, AIR 1.1
Accessor to an Array of SOAPHeaders that are to be sent on
each invocation of the operation.
Implementation public function get headers():Array
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):void
ignoreWhitespace
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):void
makeObjectsBindable
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 public function get makeObjectsBindable():Boolean public function set makeObjectsBindable(value:Boolean):void
multiplePartsFormat
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):void
request
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):void
resultFormat
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):void
resultHeaders
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.
Implementation public function get resultHeaders():Array
xmlSpecialCharsFilter
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):void
Constructor Detail
Operation
()
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.
Parameters
webService:AbstractService (default = null) — The web service upon which this Operation is invoked.
name:String (default = null) — The name of this Operation.
Method Detail
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):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) — The messageId of the invocation to cancel. Optional. If omitted, the
last service invocation is canceled.
Returns
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) — Name of a header in the SOAPHeader content (Optional)
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.
AbstractOperation 
Hide Inherited Public Properties
Show Inherited Public Properties