new ResultBase(ruleName, propertyName, message)
Creates a new rule result object.
Parameters:
| Name | Type | Description |
|---|---|---|
ruleName |
string | The name of the rule. |
propertyName |
string | The name of the property the rule belongs to. |
message |
string | Human-readable description of the reason of the failure. |
Throws:
-
Argument error: The rule name must be a non-empty string.
-
Argument error: The message must be a non-empty string.
Members
-
<readonly> isPreserved :boolean
-
Indicates whether the broken rule of this failure is preserved when a new verification starts. Typically the broken rules of authorization rules are retained.
Type:
- boolean
-
<readonly> message :string
-
Human-readable description of the reason of the failure.
Type:
- string
-
<readonly> propertyName :string
-
The name of the property the rule belongs to.
Type:
- string
-
<readonly> ruleName :string
-
The name of the rule.
Type:
- string
-
<readonly> severity :bo.rules.RuleSeverity
-
The severity of the rule failure.
Type:
-
<readonly> stopsProcessing :boolean
-
Indicates whether processing the rules of the property should stop.
Type:
- boolean
Methods
-
toBrokenRule() → {bo.rules.BrokenRule}
-
Maps the rule result to broken rule.
Returns:
The broken rule companion of the rule result.
- Type
- bo.rules.BrokenRule