ValidationResult

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

This page documents the supported public API surface only. Private, internal, benchmark, test, and implementation-detail types are intentionally omitted.

Declaration

1
public class ValidationResult

Summary

Represents the result of a validation operation.

This class contains information about whether a validation succeeded and any issues that were found during validation.

Metadata

Namespace: GridPlacement.Core.Results

Source File: cs/Core/Results/ValidationResult.cs

Assembly: GridPlacement.Core

Type: class

Constructors

ValidationResult

1
public ValidationResult()

Initializes a new instance of the ValidationResult class.


ValidationResult

1
public ValidationResult(bool isSuccessful)

Initializes a new instance of the ValidationResult class with a specific success state.

Parameters

NameDescription
isSuccessfulWhether the validation is successful.

Properties

IsSuccessful

1
public bool IsSuccessful { get; set; }

Gets whether the validation was successful.


Issues

1
public IReadOnlyList<string> Issues { get; }

Gets the list of validation issues.


IsValid

1
public bool IsValid { get; }

Errors

1
public List<ValidationError> Errors { get; }

Warnings

1
public List<ValidationWarning> Warnings { get; }

Info

1
public List<ValidationInfo> Info { get; }

Context

1
public Dictionary<string, object> Context { get; }

Methods

AddIssue

1
public void AddIssue(string issue)

Adds an issue to the validation result.

Parameters

NameDescription
issueThe issue to add.

AddError

1
public void AddError(string message)

AddWarning

1
public void AddWarning(string message)

AddInfo

1
public void AddInfo(string message)

GetIssues

1
public List<string> GetIssues()

Gets all validation issues.

Returns

A list of validation issues.


Success

1
public static ValidationResult Success()

Failure

1
public static ValidationResult Failure(params string[] issues)

Clone

1
public ValidationResult Clone()

GetErrorSummary

1
public string GetErrorSummary()