Class ContextValidationResult
- Namespace
- Excalibur.Dispatch.Validation.Context
- Assembly
- Excalibur.Dispatch.dll
Result of context validation containing details about any issues found.
public sealed class ContextValidationResult
- Inheritance
-
ContextValidationResult
- Inherited Members
- Extension Methods
Properties
CorruptedFields
Gets the list of fields detected as corrupted.
public IList<string> CorruptedFields { get; init; }
Property Value
- IList<string>
The current CorruptedFields value.
Details
Gets additional validation details.
public IDictionary<string, object?> Details { get; init; }
Property Value
- IDictionary<string, object>
Additional validation details.
FailureReason
Gets or sets the reason for validation failure.
public string FailureReason { get; set; }
Property Value
- string
The current FailureReason value.
IsValid
Gets or sets a value indicating whether the context validation was successful.
public bool IsValid { get; set; }
Property Value
MissingFields
Gets the list of missing required fields.
public IList<string> MissingFields { get; init; }
Property Value
- IList<string>
The current MissingFields value.
Severity
Gets or sets the severity of the validation issue.
public ValidationSeverity Severity { get; set; }
Property Value
- ValidationSeverity
The current Severity value.
ValidationTimestamp
Gets or sets the timestamp when validation was performed.
public DateTimeOffset ValidationTimestamp { get; set; }
Property Value
- DateTimeOffset
The current ValidationTimestamp value.
Methods
Failure(string, ValidationSeverity)
Creates a failed validation result.
public static ContextValidationResult Failure(string reason, ValidationSeverity severity = ValidationSeverity.Error)
Parameters
reasonstringThe reason for failure.
severityValidationSeverityThe severity of the issue.
Returns
- ContextValidationResult
A failed validation result.
FailureWithFields(string, IEnumerable<string>?, IEnumerable<string>?, ValidationSeverity)
Creates a failed validation result with field details.
public static ContextValidationResult FailureWithFields(string reason, IEnumerable<string>? missingFields = null, IEnumerable<string>? corruptedFields = null, ValidationSeverity severity = ValidationSeverity.Error)
Parameters
reasonstringThe reason for failure.
missingFieldsIEnumerable<string>List of missing fields.
corruptedFieldsIEnumerable<string>List of corrupted fields.
severityValidationSeverityThe severity of the issue.
Returns
- ContextValidationResult
A failed validation result with field details.
Success()
Creates a successful validation result.
public static ContextValidationResult Success()
Returns
- ContextValidationResult
A successful validation result.