Table of Contents

Class RetentionContributorResult

Namespace
Excalibur.Compliance
Assembly
Excalibur.Compliance.Abstractions.dll

Result of an IRetentionContributor enforcement pass.

public sealed record RetentionContributorResult : IEquatable<RetentionContributorResult>
Inheritance
RetentionContributorResult
Implements
Inherited Members

Properties

ErrorMessage

Gets the error message when Success is false.

public string? ErrorMessage { get; init; }

Property Value

string

RecordsCleaned

Gets the number of records cleaned (deleted) by this contributor.

public int RecordsCleaned { get; init; }

Property Value

int

Success

Gets a value indicating whether the contributor completed successfully.

public required bool Success { get; init; }

Property Value

bool

Methods

Failed(string)

Creates a failed result with the supplied error message.

public static RetentionContributorResult Failed(string errorMessage)

Parameters

errorMessage string

The error message.

Returns

RetentionContributorResult

A failed RetentionContributorResult.

Succeeded(int)

Creates a successful result for the given number of cleaned records.

public static RetentionContributorResult Succeeded(int recordsCleaned)

Parameters

recordsCleaned int

The number of records cleaned.

Returns

RetentionContributorResult

A successful RetentionContributorResult.