class static
bo.rules.ResultBase

Source: rules/result-base.js:22

Serves as the base class for the failed result of executing a rule.

Properties

isPreserved
message
propertyName
ruleName
severity
stopsProcessing

Method

toBrokenRule()

new ResultBase(ruleName, propertyName, message)

Creates a new rule result object.

Parameters

Name Type Optional 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.

Properties

read-only
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.

read-only
message  string

Human-readable description of the reason of the failure.

read-only
propertyName  string

The name of the property the rule belongs to.

read-only
ruleName  string

The name of the rule.

read-only
severity  bo.rules.RuleSeverity

The severity of the rule failure.

read-only
stopsProcessing  boolean

Indicates whether processing the rules of the property should stop.

Method

toBrokenRule() → bo.rules.BrokenRule

Maps the rule result to broken rule.

Returns

bo.rules.BrokenRule The broken rule companion of the rule result.