flash.errors.SQLError - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flash.errors
Class	public class SQLError
Inheritance	SQLError Error Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

A SQLError instance provides detailed information about a failed operation.

In asynchronous execution mode, when an error occurs with a SQL database operation the SQLConnection or SQLStatement instance dispatches a SQLErrorEvent object. Information about the error in the form of a SQLError instance can be accessed from the SQLErrorEvent object's error property.

In synchronous execution mode, when an error occurs with a SQL database operation the SQLConnection or SQLStatement instance throws a SQLError exception, which can be handled by enclosing the error-throwing code in a try..catch block.

This class provides properties containing the error details (specifying the specific type of error that occured), a text message containing the details of the error, and the operation that caused the error to occur.

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
		detailArguments : Array [read-only] An array of String values that can be used to construct a locale specific detail error message.	SQLError
		detailID : int [read-only] A reference number associated with the specific detail message.	SQLError
		details : String [read-only] Details of the current error.	SQLError
		errorID : int [read-only] Contains the reference number associated with the specific error message.	Error
		message : String Contains the message associated with the Error object.	Error
		name : String Contains the name of the Error object.	Error
		operation : String [read-only] A value indicating the operation that was being attempted when the error occurred.	SQLError
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SQLError(operation:String, details:String = "", message:String = "", id:int = 0, detailID:int = -1, detailArgs:Array = null) Creates a SQLError instance that can be thrown or used with a SQLErrorEvent instance's error property.	SQLError
		getStackTrace():String Returns the call stack for an error as a string at the time of the error's construction (for the debugger version of Flash Player and the AIR Debug Launcher (ADL) only; returns null if not using the debugger version of Flash Player or the ADL.	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 Returns the string "Error" by default or the value contained in the Error.message property, if defined.	SQLError
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

detailArguments

property

detailArguments:Array [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.1

An array of String values that can be used to construct a locale specific detail error message.

This property contains the value or values that are substituted into the details property error message to indicate the specific database object or objects (table name, column name, and so forth) associated with the error. For example, suppose an error with the following details property error message occurs in an application:

there is already another table or index with this name: 'my_table'

In that case, the SQLError instance's detailArguments property would contain a single element with the value "my_table".

Using the detailID property an application can identify the specific details error message. The application can provide alternate text for the end user in the language of his or her locale. The argument values in the detailArguments array can be substituted in the appropriate position in the error message string. This is useful for applications that wish to display the details property error message for this error directly to end users in a specific locale.

For a list of the detailID values and their corresponding English error details message and arguments, see the appendix "SQL error detail messages, ids, and arguments."

Implementation
public function get detailArguments():Array

detailID

property

detailID:int [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.1

A reference number associated with the specific detail message. This value is used to support locale specific translations of the details property error message.

This property provides a unique identifier for each details message. (For any type of error with a specific errorID there are multiple errors with unique detailID values.) Using this identifier together with the value or values in the detailArguments array, an application can provide locale specific detail error messages. This is useful for applications that wish to display the details property error message for this error directly to end users in a specific locale.

For a list of the detailID values and their corresponding English error details message and arguments, see the appendix "SQL error detail messages, ids, and arguments."

Implementation
public function get detailID():int

details

property

details:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

Details of the current error. This provides additional specific information about the error that occurred.

Implementation
public function get details():String

operation

property

operation:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

A value indicating the operation that was being attempted when the error occurred. This value is one of the constants defined in the SQLErrorOperation class.

Implementation
public function get operation():String

SQLError

()

Constructor

public function SQLError(operation:String, details:String = "", message:String = "", id:int = 0, detailID:int = -1, detailArgs:Array = null)

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

Creates a SQLError instance that can be thrown or used with a SQLErrorEvent instance's error property.

Parameters

	`operation:String` — Indicates the specific operation that caused the failure. The value is one of the constants defined in the SQLErrorOperation class.

	`details:String` (default = "") — The details for the current error.

	`message:String` (default = "") — The description of the error that occurred.

	`id:int` (default = `0`) — A reference number associated with the specific error message.

	`detailID:int` (default = `-1`) — A reference number associated with the detail error message.

	`detailArgs:Array` (default = `null`) — An ordered array of substitution values that can be used to construct a locale specific detail error message.

toString

()

method

public function toString():String

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

Returns the string "Error" by default or the value contained in the Error.message property, if defined.

Returns

String — The error message.