Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
LastOperationStatus

Package | spark.globalization
Class | public final class LastOperationStatus
Inheritance | LastOperationStatus Object

Language Version : | ActionScript 3.0

Product Version : | Flex 4.55

Runtime Versions : | Flash Player 10.1, AIR 2.5

The LastOperationStatus class enumerates constant values that represent the status of the most recent globalization service operation. These values can be retrieved through the read-only property `lastOperationStatus` available in most globalization classes.

See also

flash.globalization.LastOperationStatus

Public Constants

| Constant | Defined By
--- | --- | ---
|  | BUFFER_OVERFLOW_ERROR : String = bufferOverflowError [static] Indicates that given buffer is not enough to hold the result. | LastOperationStatus
|  | ERROR_CODE_UNKNOWN : String = errorCodeUnknown [static] Indicates that the return error code is not known. | LastOperationStatus
|  | ILLEGAL_ARGUMENT_ERROR : String = illegalArgumentError [static] Indicates that an argument passed to a method was illegal. | LastOperationStatus
|  | INDEX_OUT_OF_BOUNDS_ERROR : String = indexOutOfBoundsError [static] Indicates that an iterator went out of range or an invalid parameter was specified for month, day, or time. | LastOperationStatus
|  | INVALID_ATTR_VALUE : String = invalidAttrValue [static] Indicates that a given attribute value is out of the expected range. | LastOperationStatus
|  | INVALID_CHAR_FOUND : String = invalidCharFound [static] Indicates that invalid Unicode value was found. | LastOperationStatus
|  | LOCALE_UNDEFINED_ERROR : String = localeUndefinedError [static] Indicates that Locale is not defined. | LastOperationStatus
|  | MEMORY_ALLOCATION_ERROR : String = memoryAllocationError [static] Indicates that memory allocation has failed. | LastOperationStatus
|  | NO_ERROR : String = noError [static] Indicates that the last operation succeeded without any errors. | LastOperationStatus
|  | NUMBER_OVERFLOW_ERROR : String = numberOverflowError [static] Indicates that an operation resulted a value that exceeds a specified numeric type. | LastOperationStatus
|  | PARSE_ERROR : String = parseError [static] Indicates that the parsing of a number failed. | LastOperationStatus
|  | PATTERN_SYNTAX_ERROR : String = patternSyntaxError [static] Indicates that the pattern for formatting a number, date, or time is invalid. | LastOperationStatus
|  | PLATFORM_API_FAILED : String = platformAPIFailed [static] Indicates that an underlying platform API failed for an operation. | LastOperationStatus
|  | TRUNCATED_CHAR_FOUND : String = truncatedCharFound [static] Indicates that a truncated Unicode character value was found. | LastOperationStatus
|  | UNEXPECTED_TOKEN : String = unexpectedToken [static] Indicates that an unexpected token was detected in a Locale ID string. | LastOperationStatus
|  | UNSUPPORTED_ERROR : String = unsupportedError [static] Indicates that the requested operation or option is not supported. | LastOperationStatus
|  | USING_DEFAULT_WARNING : String = usingDefaultWarning [static] Indicates that an operating system default value was used during the most recent operation. | LastOperationStatus
|  | USING_FALLBACK_WARNING : String = usingFallbackWarning [static] Indicates that a fallback value was set during the most recent operation. | LastOperationStatus

Constant Detail

BUFFER_OVERFLOW_ERROR | Constant

`public static const BUFFER_OVERFLOW_ERROR:String = bufferOverflowError`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that given buffer is not enough to hold the result.

See also

flash.globalization.LastOperationStatus.BUFFER_OVERFLOW_ERROR

ERROR_CODE_UNKNOWN | Constant |

`public static const ERROR_CODE_UNKNOWN:String = errorCodeUnknown`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5s

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that the return error code is not known. Any non-static method or read/write properties can return this error when the operation is not successful and the return error code is not known.

See also

flash.globalization.LastOperationStatus.ERROR_CODE_UNKNOWN

ILLEGAL_ARGUMENT_ERROR | Constant |

`public static const ILLEGAL_ARGUMENT_ERROR:String = illegalArgumentError`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that an argument passed to a method was illegal.

For example, the following code shows that an invalid argument error status is set when `CurrencyFormatter.grouping` property is set to the invalid value "3;".

          var cf:CurrencyFormatter = new CurrencyFormatter();
          cf.setStyle("locale","en_US");
          cf.groupingPattern = "3;";
          trace(cf.lastOperationStatus); // "illegalArgumentError"

See also

flash.globalization.LastOperationStatus.ILLEGAL_ARGUMENT_ERROR

INDEX_OUT_OF_BOUNDS_ERROR | Constant |

`public static const INDEX_OUT_OF_BOUNDS_ERROR:String = indexOutOfBoundsError`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that an iterator went out of range or an invalid parameter was specified for month, day, or time.

See also

flash.globalization.LastOperationStatus.INDEX_OUT_OF_BOUNDS_ERROR

INVALID_ATTR_VALUE | Constant |

`public static const INVALID_ATTR_VALUE:String = invalidAttrValue`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that a given attribute value is out of the expected range.

The following example shows that setting the `NumberFormatter.negativeNumberFormat` property to an out-of-range value results in an invalid attribute value status.

          var nf:NumberFormatter = new NumberFormatter();
          nf.setStyle("locale","en_US");
          nf.negativeNumberFormat = 9;
          nf.lastOperationStatus; // "invalidAttrValue"

See also

flash.globalization.LastOperationStatus.INVALID_ATTR_VALUE

INVALID_CHAR_FOUND | Constant |

`public static const INVALID_CHAR_FOUND:String = invalidCharFound`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that invalid Unicode value was found.

See also

flash.globalization.LastOperationStatus.INVALID_CHAR_FOUND

LOCALE_UNDEFINED_ERROR | Constant |

`public static const LOCALE_UNDEFINED_ERROR:String = localeUndefinedError`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that `Locale` is not defined.

MEMORY_ALLOCATION_ERROR | Constant |

`public static const MEMORY_ALLOCATION_ERROR:String = memoryAllocationError`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that memory allocation has failed.

See also

flash.globalization.LastOperationStatus.MEMORY_ALLOCATION_ERROR

NO_ERROR | Constant |

`public static const NO_ERROR:String = noError`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that the last operation succeeded without any errors. This status can be returned by all constructors, non-static methods, static methods and read/write properties.

See also

flash.globalization.LastOperationStatus.NO_ERROR

NUMBER_OVERFLOW_ERROR | Constant |

`public static const NUMBER_OVERFLOW_ERROR:String = numberOverflowError`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that an operation resulted a value that exceeds a specified numeric type.

See also

flash.globalization.LastOperationStatus.NUMBER_OVERFLOW_ERROR

PARSE_ERROR | Constant |

`public static const PARSE_ERROR:String = parseError`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that the parsing of a number failed. This status can be returned by parsing methods of the formatter classes, such as `CurrencyFormatter.parse()` and `NumberFormatter.parseNumber()`. For example, if the value "12abc34" is passed as the parameter to the `CurrencyFormatter.parse()` method, the method returns "NaN" and sets the `lastOperationStatus` value to `LastOperationStatus.PARSE_ERROR`.

See also

flash.globalization.LastOperationStatus.PARSE_ERROR

PATTERN_SYNTAX_ERROR | Constant |

`public static const PATTERN_SYNTAX_ERROR:String = patternSyntaxError`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that the pattern for formatting a number, date, or time is invalid. This status is set when the user's operating system does not support the given pattern.

For example, the following code shows the value of the `lastOperationStatus` property after an invalid "xx" pattern is used for date formatting:

          var df:DateTimeFormatter = new DateTimeFormatter();
          df.setStyle("locale","en_US");
          df.setDateTimePattern("xx");
          trace(df.lastOperationStatus); // "patternSyntaxError"

See also

flash.globalization.LastOperationStatus.PATTERN_SYNTAX_ERROR

PLATFORM_API_FAILED | Constant |

`public static const PLATFORM_API_FAILED:String = platformAPIFailed`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that an underlying platform API failed for an operation.

See also

flash.globalization.LastOperationStatus.PLATFORM_API_FAILED

TRUNCATED_CHAR_FOUND | Constant |

`public static const TRUNCATED_CHAR_FOUND:String = truncatedCharFound`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that a truncated Unicode character value was found.

See also

flash.globalization.LastOperationStatus.TRUNCATED_CHAR_FOUND

UNEXPECTED_TOKEN | Constant |

`public static const UNEXPECTED_TOKEN:String = unexpectedToken`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that an unexpected token was detected in a Locale ID string.

For example, the following code shows the value of the `lastOperationStatus` property after an incomplete string is used when requesting a locale ID. As a result the `lastOperationStatus` property is set to the value `UNEXPECTED_TOKEN` after a call to the `LocaleID.getKeysAndValues()` method.

          var locale:flash.globalization.LocaleID = new flash.globalization.LocaleID("en-US@Collation");
          var kav:Object = locale.getKeysAndValues();
          trace(locale.lastOperationStatus); // "unexpectedToken"

See also

flash.globalization.LastOperationStatus.UNEXPECTED_TOKEN

UNSUPPORTED_ERROR | Constant |

`public static const UNSUPPORTED_ERROR:String = unsupportedError`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that the requested operation or option is not supported. This status can be returned by methods such as `DateTimeFormatter.setDateTimePattern()` and when retrieving properties suce as `Collator.ignoreCase`.

See also

flash.globalization.LastOperationStatus.UNSUPPORTED_ERROR

USING_DEFAULT_WARNING | Constant |

`public static const USING_DEFAULT_WARNING:String = usingDefaultWarning`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that an operating system default value was used during the most recent operation. Class constructors can return this status.

See also

flash.globalization.LastOperationStatus.USING_DEFAULT_WARNING

USING_FALLBACK_WARNING | Constant |

`public static const USING_FALLBACK_WARNING:String = usingFallbackWarning`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10.1, AIR 2.5

Indicates that a fallback value was set during the most recent operation. This status can be returned by constructors and methods such as `DateTimeFormatter.setDateTimeStyles()`, and when retrieving properties such as `CurrencyFormatter.groupingPattern`.

See also

flash.globalization.LastOperationStatus.USING_FALLBACK_WARNING

Wed Nov 15 2017, 09:50 AM +01:00