Interface: ItemMessage

Oracle® JavaScript Extension Toolkit (JET)
17.1.0
G12196-01

Since:
  • 9.0.0
Module:
  • ojdataprovider

QuickNav

Fields

Type Definitions

Description

The interface for ItemMetadata. Note that key is the only mandatory property, implementations can provide additional properties as needed.


Usage

Signature:

interface ItemMessage

Typescript Import Format
//To use this interface, import as below.
import {ItemMessage} from "ojs/ojdataprovider";

For additional information visit:


The interface for ItemMetadata. Note that key is the only mandatory property, implementations can provide additional properties as needed.

Fields

detail :string

Detail text of the message.
Since:
  • 9.0.0

(nullable) severity :(ItemMessage.SEVERITY_TYPE|ItemMessage.SEVERITY_LEVEL)

Severity type or level of the message.
Since:
  • 9.0.0

summary :string

Summary text of the message.
Since:
  • 9.0.0

Type Definitions

SEVERITY_LEVEL

The supported severity levels of the message.
Signature:

(1|2|3|4|5)

Supported Values:
Value Description
1 Indicates a confirmation that an operation or task was completed. This is the lowest severity level.
2 Indicates information or operation messages. This has a lower severity level than warning.
3 Indicates an application condition or situation that might require users' attention. This has a lower severity than error.
4 Used when data inaccuracies occur when completing a field and that needs fixing before user can continue. This has a lower severity level than fatal.
5 Used when a critical application error or an unknown failure occurs. This is the highest severity level.

SEVERITY_TYPE

The supported severity types of the message.
Signature:

('confirmation'|'info'|'warning'|'error'|'fatal')

Supported Values:
Value Description
confirmation Indicates a confirmation that an operation or task was completed. This is the lowest severity level.
error Used when data inaccuracies occur when completing a field and that needs fixing before user can continue. This has a lower severity level than fatal.
fatal Used when a critical application error or an unknown failure occurs. This is the highest severity level.
info Indicates information or operation messages. This has a lower severity level than warning.
warning Indicates an application condition or situation that might require users' attention. This has a lower severity than error.