dw.alert
Class Alert
Object
dw.alert.Alert
This class represents a single system alert to be shown to a Business Manager user.
Constants
PRIORITY_ACTION  :  String = "ACTION"
String constant to denote the 'action required' priority.
PRIORITY_INFO  :  String = "INFO"
String constant to denote the 'informational' priority.
PRIORITY_WARN  :  String = "WARN"
String constant to denote the 'warning' priority.
Properties
alertDescriptorID  :  String  (Read Only)
The ID of the referenced alert description.
contextObjectID  :  String  (Read Only)
The ID of the referenced context object (or null, if no context object is assigned to this alert).
displayMessage  :  String  (Read Only)
Resolves the display message to be shown. It refers to the message resource ID specified in the alert descriptor file ("message-resource-id") and the message provided by the 'alerts.properties' resource bundle. When the referenced message contains parameter placeholders (such as '{0}' and '{1}') they are replaced by the parameters stored with the alert.
priority  :  String  (Read Only)
The priority assigned to the message. One of the string constants defined in this class (PRIORITY_INFO, PRIORITY_WARN, PRIORITY_ACTION).
remediationURL  :  String  (Read Only)
The URL of the page where the user can resolve the alert, as provided in the 'alerts.json' descriptor file.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getAlertDescriptorID() : String
Returns the ID of the referenced alert description.
getContextObjectID() : String
Returns the ID of the referenced context object (or null, if no context object is assigned to this alert).
getDisplayMessage() : String
Resolves the display message to be shown.
getPriority() : String
Returns the priority assigned to the message.
getRemediationURL() : String
The URL of the page where the user can resolve the alert, as provided in the 'alerts.json' descriptor file.
Methods inherited from class Object
Method Detail
getAlertDescriptorID
getAlertDescriptorID() : String
Returns the ID of the referenced alert description.
Returns:
the ID of the referenced alert description

getContextObjectID
getContextObjectID() : String
Returns the ID of the referenced context object (or null, if no context object is assigned to this alert).
Returns:
the ID of the referenced context object

getDisplayMessage
getDisplayMessage() : String
Resolves the display message to be shown. It refers to the message resource ID specified in the alert descriptor file ("message-resource-id") and the message provided by the 'alerts.properties' resource bundle. When the referenced message contains parameter placeholders (such as '{0}' and '{1}') they are replaced by the parameters stored with the alert.
Returns:
the display message

getPriority
getPriority() : String
Returns the priority assigned to the message. One of the string constants defined in this class (PRIORITY_INFO, PRIORITY_WARN, PRIORITY_ACTION).
Returns:
the priority

getRemediationURL
getRemediationURL() : String
The URL of the page where the user can resolve the alert, as provided in the 'alerts.json' descriptor file.
Returns:
the remediation URL