Class ValidationReport

Namespace

EncDotNet.S100.Validation

Assembly

EncDotNet.S100.Core.dll

Aggregated outcome of running a ValidationRuleSet<TModel> against a typed dataset model.

public sealed record ValidationReport : IEquatable<ValidationReport>

Inheritance

object

ValidationReport

Implements

IEquatable<ValidationReport>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ValidationReport(IReadOnlyList<ValidationFinding>, int, int)

Aggregated outcome of running a ValidationRuleSet<TModel> against a typed dataset model.

public ValidationReport(IReadOnlyList<ValidationFinding> Findings, int RulesEvaluated, int RulesWithFindings)

Parameters

Findings IReadOnlyList<ValidationFinding>

All findings emitted across all rules, preserving the order in which they were produced.

RulesEvaluated int

The number of rules that were evaluated.

RulesWithFindings int

The number of rules that emitted at least one finding.

Properties

Empty

An empty report (no rules, no findings).

public static ValidationReport Empty { get; }

Property Value

ValidationReport

Findings

All findings emitted across all rules, preserving the order in which they were produced.

public IReadOnlyList<ValidationFinding> Findings { get; init; }

Property Value

IReadOnlyList<ValidationFinding>

HasErrors

True when any finding has severity Error.

public bool HasErrors { get; }

Property Value

bool

HasWarnings

True when any finding has severity Warning.

public bool HasWarnings { get; }

Property Value

bool

IsValid

True when no rule emitted a finding.

public bool IsValid { get; }

Property Value

bool

RulesEvaluated

The number of rules that were evaluated.

public int RulesEvaluated { get; init; }

Property Value

int

RulesWithFindings

The number of rules that emitted at least one finding.

public int RulesWithFindings { get; init; }

Property Value

int

Methods

FindingsOfSeverity(ValidationSeverity)

Returns findings filtered to a particular severity.

public IEnumerable<ValidationFinding> FindingsOfSeverity(ValidationSeverity severity)

Parameters

severity ValidationSeverity

Returns

IEnumerable<ValidationFinding>