Class: AuthorizationResult

bo.rules. AuthorizationResult

Represents the failed result of executing an authorization rule.

new AuthorizationResult(ruleName, targetName, message)

Creates a new authorization rule result object.

Parameters:
Name Type Argument Description
ruleName string

The name of the rule.

targetName string <optional>

An eventual parameter of the authorization action.

message string

Human-readable description of the reason of the failure.

Throws:

Extends

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
Inherited From:

<readonly> message :string

Human-readable description of the reason of the failure.

Type:
  • string
Inherited From:

<readonly> propertyName :string

The name of the property the rule belongs to.

Type:
  • string
Inherited From:

<readonly> ruleName :string

The name of the rule.

Type:
  • string
Inherited From:

<readonly> severity :bo.rules.RuleSeverity

The severity of the rule failure.

Type:
Inherited From:

<readonly> stopsProcessing :boolean

Indicates whether processing the rules of the property should stop.

Type:
  • boolean
Inherited From:

Methods

toBrokenRule() → {bo.rules.BrokenRule}

Maps the rule result to broken rule.

Inherited From:
Returns:

The broken rule companion of the rule result.

Type
bo.rules.BrokenRule
If you find bugs or have feature requests, please let us know.

JavaScript business objects ♦ Copyright © 2014-2016 Logikum, Ltd.
Documentation generated by JSDoc 3.2.2 on 2015. December 31. using the DocStrap template.