business-objects v1.1.0 Class: ValidationRule

Class: ValidationRule

bo .rules. ValidationRule

Represents a validation rule.

new ValidationRule(ruleName)

Creates a new validation rule object. The rule instances should be frozen.

Parameters:

Name	Type	Description
`ruleName`	string	The name of the rule. It is typically the name of the constructor, without the Rule suffix.

Throws:

Argument error: The rule name must be a non-empty string.

Extends

bo.rules.RuleBase

Members

<readonly> message :string

Human-readable description of the rule failure.

Type:

string

Inherited From:

bo.rules.RuleBase#message

<readonly> primaryProperty :bo.shared.PropertyInfo

The definition of the property the rule relates to.

Type:

bo.shared.PropertyInfo

<readonly> priority :number

The priority of the rule. Higher number means higher priority.

Type:

number

Inherited From:

bo.rules.RuleBase#priority

Default Value:

<readonly> ruleName :string

The name of the rule type. The default value usually the name of the constructor, without the Rule suffix.

Type:

string

Inherited From:

bo.rules.RuleBase#ruleName

<readonly> stopsProcessing :boolean

Indicates whether processing of the rules for a property stops when the rule fails.

Type:

boolean

Inherited From:

bo.rules.RuleBase#stopsProcessing

Default Value:

false

Methods

addAffectedProperty(property)

Adds an additional property that is influenced by the rule.

Parameters:

Name	Type	Description
`property`	bo.shared.PropertyInfo	An affected property influenced by the rule.

Throws:

Argument error: The affected property must be a PropertyInfo object.

addInputProperty(property)

Adds an additional property to the rule that will use its value.

Parameters:

Name	Type	Description
`property`	bo.shared.PropertyInfo	An input property that value is used by the rule of.

Throws:

Argument error: The input property must be a PropertyInfo object.

<virtual> execute(inputs)

Abstract method to check if the rule is valid for the property.

Parameters:

Name	Type	Description
`inputs`	Array.<*>	An array of the values of the required properties.

Inherited From:

bo.rules.RuleBase#execute

Throws:

Not implemented error: The Rule.execute method is not implemented.

<protected> getInputValues(getValue) → {object}

Returns the values of the properties that are used by the rule. This method is called by the rule manager internally to provide the values of the input properties for the execute() method.

Parameters:

Name	Type	Description
`getValue`	internal~getValue	A function that returns the value of a property.

Throws:

Argument error: The getValue argument must be a function..

Returns:

An object that properties hold the values of the input properties of.

Type: object

initialize(primaryProperty, message, priority, stopsProcessing)

Sets the properties of the rule.

Parameters:

Name	Type	Argument	Default	Description
`primaryProperty`	bo.shared.PropertyInfo			The property definition the rule relates to.
`message`	string			Human-readable description of the rule failure.
`priority`	number	<optional>	10	The priority of the rule.
`stopsProcessing`	boolean	<optional>	false	Indicates the rule behavior in case of failure.

Throws:

Argument error: The primary property must be a PropertyInfo object.
Argument error: The message must be a non-empty string.

result(message, severity) → {bo.rules.ValidationResult}

Returns the result of the rule executed.

Parameters:

Name	Type	Argument	Description
`message`	string	<optional>	Human-readable description of the rule failure.
`severity`	bo.rules.RuleSeverity		The severity of the failed rule.

Returns:

The result of the validation rule.

Type: bo.rules.ValidationResult