Class CommandValidationResult

Namespace

Core.CliniCore.Commands

Assembly

Core.CliniCore.dll

Represents the result of command validation.

public class CommandValidationResult

Inheritance

object

CommandValidationResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

Errors

Gets or sets the list of validation errors.

public List<string> Errors { get; set; }

Property Value

List<string>

IsValid

Gets or sets a value indicating whether the validation passed.

public bool IsValid { get; set; }

Property Value

bool

Warnings

Gets or sets the list of non-blocking validation warnings.

public List<string> Warnings { get; set; }

Property Value

List<string>

Methods

AddError(string)

Adds an error to the validation result.

public CommandValidationResult AddError(string error)

Parameters

error string

The error message to add.

Returns

CommandValidationResult

The current CommandValidationResult instance for method chaining.

AddWarning(string)

Adds a warning to the validation result.

public CommandValidationResult AddWarning(string warning)

Parameters

warning string

The warning message to add.

Returns

CommandValidationResult

The current CommandValidationResult instance for method chaining.

Failure(List<string>)

Creates a failed validation result with the specified list of error messages.

public static CommandValidationResult Failure(List<string> errors)

Parameters

errors List<string>

The validation error messages.

Returns

CommandValidationResult

A CommandValidationResult indicating validation failure.

Failure(string)

Creates a failed validation result with a single error message.

public static CommandValidationResult Failure(string error)

Parameters

error string

The validation error message.

Returns

CommandValidationResult

A CommandValidationResult indicating validation failure.

Failure(params string[])

Creates a failed validation result with multiple error messages.

public static CommandValidationResult Failure(params string[] errors)

Parameters

errors string[]

The validation error messages.

Returns

CommandValidationResult

A CommandValidationResult indicating validation failure.

GetDisplayMessage()

Gets a user-friendly display message describing the validation result.

public string GetDisplayMessage()

Returns

string

A formatted message indicating whether validation passed and any errors or warnings.

Merge(CommandValidationResult)

Merges another validation result into this instance.

public CommandValidationResult Merge(CommandValidationResult other)

Parameters

other CommandValidationResult

The other validation result to merge.

Returns

CommandValidationResult

The current CommandValidationResult instance for method chaining.

Success()

Creates a successful validation result.

public static CommandValidationResult Success()

Returns

CommandValidationResult

A CommandValidationResult indicating validation success.

ToString()

Returns a string that represents the current CommandValidationResult.

public override string ToString()

Returns

string

A formatted string containing validation status, error count, and warning count.