Class PolicyResultBase<TMetadata>

Namespace

Motiv

Assembly

Motiv.dll

Represents a "policy result" whereby an arbitrary rule causes a single metadata instance to be returned.

public abstract class PolicyResultBase<TMetadata> : BooleanResultBase<TMetadata>, IEquatable<BooleanResultBase>, IEquatable<bool>

Type Parameters

TMetadata

Inheritance

object

BooleanResultBase

BooleanResultBase<TMetadata>

PolicyResultBase<TMetadata>

Implements

IEquatable<BooleanResultBase>

IEquatable<bool>

Derived

PolicyResult<TModel, TMetadata>

Inherited Members

BooleanResultBase<TMetadata>.Values

BooleanResultBase<TMetadata>.RootValues

BooleanResultBase<TMetadata>.MetadataTier

BooleanResultBase<TMetadata>.CausesWithValues

BooleanResultBase<TMetadata>.UnderlyingMetadataSources

BooleanResultBase<TMetadata>.UnderlyingWithValues

BooleanResultBase<TMetadata>.And(BooleanResultBase<TMetadata>)

BooleanResultBase<TMetadata>.AndAlso(BooleanResultBase<TMetadata>)

BooleanResultBase<TMetadata>.Or(BooleanResultBase<TMetadata>)

BooleanResultBase<TMetadata>.OrElse(BooleanResultBase<TMetadata>)

BooleanResultBase<TMetadata>.XOr(BooleanResultBase<TMetadata>)

BooleanResultBase.Satisfied

BooleanResultBase.Reason

BooleanResultBase.UnderlyingReasons

BooleanResultBase.UnderlyingExpressionResults

BooleanResultBase.Justification

BooleanResultBase.Assertions

BooleanResultBase.AllAssertions

BooleanResultBase.SubAssertions

BooleanResultBase.AllSubAssertions

BooleanResultBase.RootAssertions

BooleanResultBase.AllRootAssertions

BooleanResultBase.Description

BooleanResultBase.Explanation

BooleanResultBase.Causes

BooleanResultBase.UnderlyingAssertionSources

BooleanResultBase.UnderlyingAllAssertionSources

BooleanResultBase.Underlying

BooleanResultBase.Equals(bool)

BooleanResultBase.Equals(BooleanResultBase)

BooleanResultBase.ToString()

BooleanResultBase.And(BooleanResultBase)

BooleanResultBase.AndAlso(BooleanResultBase)

BooleanResultBase.Or(BooleanResultBase)

BooleanResultBase.OrElse(BooleanResultBase)

BooleanResultBase.XOr(BooleanResultBase)

BooleanResultBase.Equals(object)

BooleanResultBase.GetHashCode()

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

EnumerableExtensions.ToEnumerable<T>(T)

Properties

Value

The single metadata instance that is returned by the policy.

public abstract TMetadata Value { get; }

Property Value

TMetadata

Remarks

For a short-circuiting composition (OrElse(PolicyResultBase<TMetadata>) or AndAlso(PolicyResultBase<TMetadata>)) this value is a selection — the last-evaluated operand's — and not a guarantee that only one cause exists. When such a composition has more than one contributing cause, Values reports all of them, so Value is not necessarily Values.Single().

Methods

AndAlso(PolicyResultBase<TMetadata>)

Performs a conditional AND operation between the current PolicyResultBase instance and another PolicyResultBase instance. The right operand does not contribute when the left operand is unsatisfied, since an unsatisfied left operand already determines the outcome.

public PolicyResultBase<TMetadata> AndAlso(PolicyResultBase<TMetadata> right)

Parameters

right PolicyResultBase<TMetadata>

The other policy result instance to perform the AND operation with.

Returns

PolicyResultBase<TMetadata>

A new policy result instance representing the result of the AND operation.

Not()

Returns a new instance of Motiv.Not.NotPolicyResult<TMetadata> that represents the logical negation of the current instance.

public PolicyResultBase<TMetadata> Not()

Returns

PolicyResultBase<TMetadata>

A new instance of Motiv.Not.NotBooleanOperationResult<TMetadata> that represents the logical negation of the current instance.

OrElse(PolicyResultBase<TMetadata>)

Performs a conditional OR operation between the current PolicyResultBase instance and another PolicyResultBase instance. This will short-circuit the evaluation of the right operand if the left operand is satisfied.

public PolicyResultBase<TMetadata> OrElse(PolicyResultBase<TMetadata> right)

Parameters

right PolicyResultBase<TMetadata>

The other policy result instance to perform the OR operation with.

Returns

PolicyResultBase<TMetadata>

A new policy result instance representing the result of the OR operation.

Operators

operator !(PolicyResultBase<TMetadata>)

Creates a new PolicyResultBase<TMetadata> that is equivalent to a logical "NOT" of the current policy.

public static PolicyResultBase<TMetadata> operator !(PolicyResultBase<TMetadata> policyResult)

Parameters

policyResult PolicyResultBase<TMetadata>

The policy to negate

Returns

PolicyResultBase<TMetadata>

A new PolicyBase<TModel, TMetadata> that will perform the "Not" operation when evaluated.