Packagemx.rpc.soap
Classpublic class Operation
InheritanceOperation Inheritance AbstractOperation Inheritance AbstractInvoker Inheritance EventDispatcher Inheritance Object
SubclassesOperation

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.


Public Properties
 PropertyDefined by
 Inheritedarguments : Object
The arguments to pass to the Operation when it is invoked.
AbstractOperation
 Inheritedconstructor : 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
  headers : Array
[read-only] Accessor to an Array of SOAPHeaders that are to be sent on each invocation of the operation.
Operation
 InheritedlastResult : Object
The result of the last invocation.
AbstractInvoker
  makeObjectsBindable : Boolean
When this value is true, anonymous objects returned are forced to bindable objects.
Operation
 Inheritedname : String
The name of this Operation.
AbstractOperation
 Inheritedprototype : 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
  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
 Inheritedservice : AbstractService
Provides convenient access to the service on which the Operation is being invoked.
AbstractOperation
  targetNamespace : String
Operation
Public Methods
 MethodDefined by
  
Operation(webService:AbstractService = null, name:String = null)
Creates a new Operation.
Operation
 Inherited
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
  
addHeader(header:SOAPHeader):void
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
 Inherited
cancel():void
Cancels the last service invocation.
AbstractInvoker
  
clearHeaders():void
Clears the headers for this individual Operation.
Operation
 Inherited
clearResult(fireBindingEvent:Boolean = true):void
Sets the result property of the invoker to null.
AbstractInvoker
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
  
getHeader(qname:QName, headerName:String = null):SOAPHeader
Returns a header if a match is found based on QName localName and URI.
Operation
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
removeHeader(qname:QName, headerName:String = null):void
Removes the header with the given QName from all operations.
Operation
 Inherited
send(... args):AsyncToken
Executes the method.
AbstractOperation
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined by
  
createFaultEvent(faultCode:String = null, faultString:String = null, faultDetail:String = null):FaultEvent
Operation
Events
 EventSummaryDefined by
 Inherited
fault
Dispatched when an Operation call fails.AbstractOperation
 Inherited
result
Dispatched when an Operation invocation successfully returns.AbstractOperation
Property detail
endpointURIproperty
endpointURI:String  [read-write]

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
headersproperty 
headers:Array  [read-only]

Accessor to an Array of SOAPHeaders that are to be sent on each invocation of the operation.

Implementation
    public function get headers():Array
makeObjectsBindableproperty 
makeObjectsBindable:Boolean  [read-write]

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
requestproperty 
request:Object  [read-write]

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
resultFormatproperty 
resultFormat:String  [read-write]

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
resultHeadersproperty 
resultHeaders:Array  [read-only]

The headers that were returned as part of the last execution of this operation. They match up with the result 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
targetNamespaceproperty 
public var targetNamespace:String
Constructor detail
Operation()constructor
public function Operation(webService:AbstractService = null, name:String = null)

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)
 
name:String (default = null)
Method detail
addHeader()method
public function addHeader(header:SOAPHeader):void

Adds a header that is applied only to this Operation.

Parameters
header:SOAPHeader — The actual header.
addSimpleHeader()method 
public function addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void

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.
clearHeaders()method 
public function clearHeaders():void

Clears the headers for this individual Operation.

createFaultEvent()method 
protected function createFaultEvent(faultCode:String = null, faultString:String = null, faultDetail:String = null):FaultEventParameters
faultCode:String (default = null)
 
faultString:String (default = null)
 
faultDetail:String (default = null)

Returns
FaultEvent
getHeader()method 
public function getHeader(qname:QName, headerName:String = null):SOAPHeader

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)

Returns
SOAPHeader
removeHeader()method 
public function removeHeader(qname:QName, headerName:String = null):void

Removes the header with the given QName from all operations.

Parameters
qname:QName — QName of the SOAPHeader.
 
headerName:String (default = null) — Name of a header in the SOAPHeader content (Optional)



© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/rpc/soap/Operation.html