Class StatusItem

• TopLevel.Object
  • dw.system.StatusItem

A StatusItem holds all the status information. Multi StatusItems are bundled together into a Status.

Property Summary 

Property	Description
code: String	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.
details: Map (read-only)	Returns the optional details for this StatusItem.
error: Boolean (read-only)	Returns whether this Status Item represents and error.
message: String	Returns the default human readable message for this Status.
parameters: List	Returns the parameters to construct a custom message.
status: Number	Returns the status.

Constructor Summary 

Constructor	Description
StatusItem()	Constructs a new OK StatusItem.
StatusItem(Number)	Constructs a new StatusItem with the given status.
StatusItem(Number, String)	Constructs a new StatusItem with the given status and code.
StatusItem(Number, String, String, Object…)	Constructs a new StatusItem with the given values.

Method Summary 

Method	Description
addDetail(String, Object)	Add an additional detail to this StatusItem.
getCode()	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.
getDetails()	Returns the optional details for this StatusItem.
getMessage()	Returns the default human readable message for this Status.
getParameters()	Returns the parameters to construct a custom message.
getStatus()	Returns the status.
isError()	Returns whether this Status Item represents and error.
setCode(String)	Method to set the status code.
setMessage(String)	Sets the default human readable message for this Status.
setParameters(Object[])	Sets the parameters for a custom message.
setStatus(Number)	Set the status.

Methods inherited from class Object 

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

Property Details 

code 

code: String

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.

---

details 

details: Map (read-only)

Returns the optional details for this StatusItem.

---

error 

error: Boolean (read-only)

Returns whether this Status Item represents and error.

---

message 

message: String

Returns the default human readable message for this Status.

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.

---

parameters 

parameters: List

Returns the parameters to construct a custom message.

---

status 

status: Number

Returns the status.

---

Constructor Details 

StatusItem() 

StatusItem()

Constructs a new OK StatusItem.

---

StatusItem(Number) 

StatusItem(status: Number)

Constructs a new StatusItem with the given status.

Parameters:

• status - either Status.OK or Status.ERROR.

---

StatusItem(Number, String) 

StatusItem(status: Number, code: String)

Constructs a new StatusItem with the given status and code.

Parameters:

• status - either Status.OK or Status.ERROR.
• code - a string representing a more detailed status code, e.g. "IMPEX-120".

---

StatusItem(Number, String, String, Object...) 

StatusItem(status: Number, code: String, message: String, parameters: Object...)

Constructs a new StatusItem with the given values.

Parameters:

• status - Status.OK or Status.ERROR.
• code - a string representing a more detailed status code, e.g. "IMPEX-120".
• message - a default human readable message
• parameters - a list of parameters to construct a custom message

---

Method Details 

addDetail(String, Object) 

addDetail(key: String, value: Object): void

Add an additional detail to this StatusItem.

Parameters:

• key - the key for the detail.
• value - the detail value.

---

getCode() 

getCode(): String

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:

• the status code.

---

getDetails() 

getDetails(): Map

Returns the optional details for this StatusItem.

Returns:

• the optional details for this StatusItem.

---

getMessage() 

getMessage(): String

Returns the default human readable message for this Status.

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:

• the default human readable message for this Status.

---

getParameters() 

getParameters(): List

Returns the parameters to construct a custom message.

Returns:

• the parameters to construct a custom message.

---

getStatus() 

getStatus(): Number

Returns the status.

Returns:

• either Status.OK or Status.ERROR.

---

isError() 

isError(): Boolean

Returns whether this Status Item represents and error.

Returns:

• true is this item represents an error, false otherwise.

---

setCode(String) 

setCode(code: String): void

Method to set the status code. 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.

Parameters:

• code - the status code.

---

setMessage(String) 

setMessage(message: String): void

Sets the default human readable message for this Status.

Parameters:

• message - the default human readable message for this Status.

---

setParameters(Object[]) 

setParameters(parameters: Object[]): void

Sets the parameters for a custom message.

Parameters:

• parameters - the parameters for a custom message.

---

setStatus(Number) 

setStatus(status: Number): void

Set the status.

Parameters:

• status - either Status.OK or Status.ERROR.

---