mx.rpc.soap

# SOAPFault - AS3 Flex

Package | mx.rpc.soap
Class | public class SOAPFault
Inheritance | SOAPFault Fault Error Object

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

A subclass of mx.rpc.Fault that provides SOAP specific information from a SOAP envelope Fault element.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | content : Object The raw content of the fault (if available), such as an HTTP response body. | Fault
|  | detail : String The detail property is the same as faultDetail but exists to match the case of the detail element in a SOAP Fault. | SOAPFault
|  | element : XML The raw XML of this SOAP Fault. | SOAPFault
|  | errorID : int [read-only] Contains the reference number associated with the specific error message. | Error
|  | faultactor : String A SOAP Fault may provide information about who caused the fault through a faultactor property. | SOAPFault
|  | faultcode : QName The faultcode property is similar to faultCode but exists to both match the case of the faultcode element in a SOAP Fault and to provide the fully qualified name of the code. | SOAPFault
|  | faultCode : String [read-only] A simple code describing the fault. | Fault
|  | faultDetail : String [read-only] Any extra details of the fault. | Fault
|  | faultstring : String The faultstring property is the same as faultString but exists to match the case of the faultstring element in a SOAP envelope Fault. | SOAPFault
|  | faultString : String [read-only] Text description of the fault. | Fault
|  | message : String Contains the message associated with the Error object. | Error
|  | name : String Contains the name of the Error object. | Error
|  | rootCause : Object The cause of the fault. | Fault

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SOAPFault(faultCode:QName, faultString:String, detail:String = null, element:XML = null, faultactor:String = null) Constructs a new SOAPFault. | SOAPFault
|  | getStackTrace():String Returns the call stack for an error at the time of the error's construction as a string. | Error
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns the String "SOAPFault" plus the faultCode, faultString, and faultDetail. | SOAPFault
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### detail

property

`detail:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The detail property is the same as faultDetail but exists to match the case of the detail element in a SOAP Fault.

Implementation
`public function get detail():String`
`public function set detail(value:String):void`

Related API Elements

mx.rpc.Fault.faultDetail

### element

property

`public var element:XML`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The raw XML of this SOAP Fault.

### faultactor

property

`public var faultactor:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

A SOAP Fault may provide information about who caused the fault through a faultactor property.

### faultcode

property

`public var faultcode:QName`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The faultcode property is similar to faultCode but exists to both match the case of the faultcode element in a SOAP Fault and to provide the fully qualified name of the code.

Related API Elements

mx.rpc.Fault.faultDetail

### faultstring

property

`faultstring:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The faultstring property is the same as faultString but exists to match the case of the faultstring element in a SOAP envelope Fault.

Implementation
`public function get faultstring():String`
`public function set faultstring(value:String):void`

Related API Elements

mx.rpc.Fault.faultString
Constructor Detail

### SOAPFault

()
Constructor

`public function SOAPFault(faultCode:QName, faultString:String, detail:String = null, element:XML = null, faultactor:String = null)`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructs a new SOAPFault.

Parameters

| `faultCode:QName` — The fully qualified name of the fault code.
| `faultString:String` — The description of the fault.
| `detail:String` (default = `null`)`` — Any extra details of the fault.
| `element:XML` (default = `null`)`` — The raw XML of the SOAP fault.
| `faultactor:String` (default = `null`)`` — Information about who caused the SOAP fault.

Method Detail

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the String "SOAPFault" plus the faultCode, faultString, and faultDetail.

Returns

| `String` — Returns the String "SOAPFault" plus the faultCode, faultString, and faultDetail.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00