Constructor
new Message(summary, detail, severity)
Constructs a message object
.
Parameters:
Name | Type | Description |
---|---|---|
summary |
string | Localized summary message text |
detail |
string | Localized detail message text |
severity |
number | string | An optional severity for this message. Use constants oj.Message.SEVERITY_LEVEL for number types and oj.Message.SEVERITY_TYPE for string types. Default is SEVERITY_ERROR if no severity is specified |
- Source:
- ojvalidation/Message.js, line 17
Fields
-
<static> SEVERITY_LEVEL
-
Message severity level
- Source:
- ojvalidation/Message.js, line 64
-
<static, constant> SEVERITY_TYPE
-
Message Severity Type.
- Source:
- ojvalidation/Message.js, line 27
Methods
-
<static> getMaxSeverity(messages) → {number}
-
A convenience method that returns the max severity level in a array of message objects.
Parameters:
Name Type Description messages
Array an array of message instances - Source:
- ojvalidation/Message.js, line 211
Returns:
-1 if none can be determined; otherwise a severity level as defined by oj.Message.SEVERITY_LEVEL.- Type
- number
-
<static> getSeverityLevel(severity) → {number}
-
A convenience method that returns the severity level when given either a severity level of type number or a severity type of string. If severity level is not provided or is not valid this returns a severity error.
Parameters:
Name Type Description severity
string | number | undefined - Source:
- ojvalidation/Message.js, line 139
Returns:
- Type
- number
-
<static> getSeverityType(level) → {string}
-
A convenience method that returns the severity type when given either a severity level of type number or a severity type of string. If severity level is not provided or is not valid this return a severity error.
Parameters:
Name Type Description level
string | number | undefined - Source:
- ojvalidation/Message.js, line 174
Returns:
- Type
- string
-
<static> isValid(messages) → {boolean}
-
A convenience method to determine the validity of the messages.
Parameters:
Name Type Description messages
Array an array of message instances - Source:
- ojvalidation/Message.js, line 236
Returns:
true if none of the messages are of severity error or greater. false otherwise- Type
- boolean
-
equals(msg)
-
Indicates whether some other oj.Message instance - msg, is "equal to" this one. Method is equivalent to java ".equals()" method.
Parameters:
Name Type Description msg
Object - Source:
- ojvalidation/Message.js, line 115
-
Init(summary, detail, severity)
-
Initializes Message instance with the set options
Parameters:
Name Type Description summary
string a lcalized summary message text detail
string a localized detail message text severity
number | string An optional severity for this message. Use constants oj.Message.SEVERITY_LEVEL for number types and oj.Message.SEVERITY_TYPE for string types. - Source:
- ojvalidation/Message.js, line 84