# Status

# What

The abstract Status class provides methods to create a new Status object based on an existing Status Code.

Status codes are defined by creating an Environment Status Asset within your Project. Within this Asset you can create one or more Vendors which in turn may have a number of Status entries.

Each of those Status entries has the following structure:

ID: A unique number
Logical name: A name which uniquely identifies a Status, e.g. FIELD_UNKNOWN
Language: One of the supported language codes, e.g. en
Message: The actual Status message. The message may contain placeholders, e.g. The field with name %1 is unknown. In this example, the placeholder %1 is filled with the respective value when creating the Status using method create.

# How to use

Based on the Vendor and the logical status name which you have defined, you can create a new Status. The Status can then be attached to a message or a passed as a result code when rolling back a stream (example).

# Definition

Kind: global class

Status
- instance
  - .getCode() ⇒ string
  - .getMessage() ⇒ string
  - .getParameters() ⇒ Array.<string>
  - .getSubStatus() ⇒ Array.<Status>
  - .getVendor() ⇒ VendorInfo
- static
  - .create(vendor, statusCode, ...args) ⇒ Status
  - .getVendorByName(vendorLongName) ⇒ VendorInfo

# getCode

Returns the code of a Status.

Example:

// Get the status code
const code = status.getCode();
// Result: 4711

Kind: instance method of Status
Returns: string - - Status code

# getMessage

Returns the uncompiled message of a Status. If it includes placeholders, these will not be filled.

Example:

// Get the status message. Placeholders defined in a Status are not replaced with parameters, if any.
const message = status.getMessage();
// Result: "The name is %1, %2."

Kind: instance method of Status
Returns: string - - Status message

# getParameters

Returns an array of parameters which may have been passed to the Status upon creation. See: create

Example:

// Get array of parameters.
const paramArray = status.getParameters();
// Result: ["Doe", "John"]

Kind: instance method of Status
Returns: Array.<string> - - Array of Status parameters which were passed when Status was created.

# getSubStatus

Returns an array of States which are sub states to the current Status.

Example:

// Get array of States.
const statusArray = status.getSubStatus();

Kind: instance method of Status
Returns: Array.<Status> - - Array of States which are sub states to the current Status.

# getVendor

Returns the vendor of a Status.

Example:

// Get array of parameters.
const VENDOR_INFO = status.getVendor();

Kind: instance method of Status
Returns: VendorInfo - - VendorInfo structure.

# create

Invoke to create a Status.

Kind: static method of Status
Returns: Status - Instance of newly created Status.

Example:

// Assume we have - among others - the following status defined using a Environment Status Asset:
// Logical name: "ILLEGAL_VALUE"
// Message: "Field with name '%1' contains illegal value '%2'."


// Get the vendor instance from the list of defined vendors.
// You must have defined the vendor in an Environment Status Asset.
// The string passed in `Status.getVendorByName('myVendorLongName')`
// is the long name of the Vendor definition within that Asset.
// Check documentation for "Environment Status Asset" for more info.
const VENDOR = Status.getVendorByName('MyVendorLongName');

// Create the Status
const STATUS = Status.create(
     VENDOR,
     'ILLEGAL_VALUE',
     'LastName',
     'Putin'
);

// In the above, the message placeholders %1 and %2 will be replaced by "LastName" and "Putin".
// So the final message is "Field with name 'LastName' contains illegal value 'Putin'."

Param	Type	Description
vendor	`VendorInfo`	Status messages can be distinguished by vendor. Pass a VendorInfo here. Obtain it with getVendorByName
statusCode	`string`	The `statusCode` which must be defined within your Environment Status Asset of your Project. This code will be used to identify the Status which you want to add.
...args	`string`	A comma separated list of arguments which will be used to fill in the placeholders in the predefined Status message, if any

# getVendorByName

Get the vendor instance from the list of defined vendors. You must have defined the vendor in an Environment Status Asset. The string passed in Status.getVendorByName('myVendorLongName') is the long name of the Vendor definition within that Asset. Check documentation for "Environment Status Asset" for more info.

Kind: static method of Status
Returns: VendorInfo - Instance of VendorInfo

Example:

const VENDOR_INFO = Status.getVendorByName('MyVendorLongName');

Param	Type	Description
vendorLongName	`string`	The long name of the vendor as defined in the specific Environment Status Asset.

← Service Stream →