A Status is used for communicating an API status code back to a client. A status consists of multiple StatusItem. Most often a Status contains only one StatusItem. For convenience, a message with parameters is formatted using standard formatting patterns. If you want to display locale-specific messages in your application, you should use the Status.getCode() as key for a resource bundle.
| Property | Description |
|---|---|
| ERROR: Number | status value to indicate an ERROR status |
| OK: Number | status value to indicate an OK status |
code: String (read-only) | Returns the status code either of the first ERROR StatusItem or when there is no ERROR StatusITEM, the first StatusItem in the overall list. |
details: Map (read-only) | Returns the details either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list. |
error: Boolean (read-only) | Checks if the status is an ERROR. |
items: List (read-only) | Returns all status items. |
message: String (read-only) | Returns the message either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list. |
parameters: List (read-only) | Returns the parameters either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list. |
status: Number (read-only) | Returns the overall status. |
| Constructor | Description |
|---|---|
| Status() | Creates a Status object with no StatusItems. |
| Status(Number) | Creates a Status with a single StatusItem. |
| Status(Number, String) | Creates a Status with a single StatusItem. |
| Status(Number, String, String, Object…) | Creates a Status with a single StatusItem. |
| Method | Description |
|---|---|
| addDetail(String, Object) | Add detail information for the given key of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list. |
| addItem(StatusItem) | Adds an additional status item to this status instance. |
| getCode() | Returns the status code either of the first ERROR StatusItem or when there is no ERROR StatusITEM, the first StatusItem in the overall list. |
| getDetail(String) | Returns the detail value for the given key of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list. |
| getDetails() | Returns the details either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list. |
| getItems() | Returns all status items. |
| getMessage() | Returns the message either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list. |
| getParameters() | Returns the parameters either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list. |
| getStatus() | Returns the overall status. |
| isError() | Checks if the status is an ERROR. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
status value to indicate an ERROR status
status value to indicate an OK status
(read-only)Returns the status code either of the first ERROR StatusItem or when there is no ERROR StatusITEM, the first StatusItem in the overall list.
The status code is the unique identifier for the message and can be used by client programs to check for a specific status and to generate a localized message.
(read-only)Returns the details either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.
(read-only)Checks if the status is an ERROR. The Status is an ERROR if one of the contained StatusItems is an ERROR.
(read-only)Returns all status items.
(read-only)Returns the message either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.
Note: Custom code and client programs must not use this message to identify a specific status. The getCode() must be used for that purpose. The actual message can change from release to release.
(read-only)Returns the parameters either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.
(read-only)Returns the overall status. If all StatusItems are OK, the method returns OK. If one StatusItem is an ERROR it returns ERROR.
Creates a Status object with no StatusItems.
Creates a Status with a single StatusItem. The status is set to the given value.
Parameters:
Creates a Status with a single StatusItem. The StatusItem is initialized with the given values.
Parameters:
Creates a Status with a single StatusItem. The StatusItem is initialized with the given values.
Parameters:
Add detail information for the given key of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.
Parameters:
Adds an additional status item to this status instance.
Parameters:
Returns the status code either of the first ERROR StatusItem or when there is no ERROR StatusITEM, the first StatusItem in the overall list.
The status code is the unique identifier for the message and can be used by client programs to check for a specific status and to generate a localized message.
Returns:
Returns the detail value for the given key of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.
Parameters:
Returns:
Returns the details either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.
Returns:
Returns all status items.
Returns:
Returns the message either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.
Note: Custom code and client programs must not use this message to identify a specific status. The getCode() must be used for that purpose. The actual message can change from release to release.
Returns:
Returns the parameters either of the first ERROR StatusItem or when there is no ERROR StatusItem, the first StatusItem in the overall list.
Returns:
Returns the overall status. If all StatusItems are OK, the method returns OK. If one StatusItem is an ERROR it returns ERROR.
Returns:
Checks if the status is an ERROR. The Status is an ERROR if one of the contained StatusItems is an ERROR.
Returns:
j