Interface IOutcomeStatus

Describes the success or failure outcome of a process, e.g. of a completed worker or port.

Namespace: actionETL

Assembly: actionETL.dll

Syntax

public interface IOutcomeStatus

Properties

Category

Gets the category, which describes what generated the status.

Declaration

string Category { get; }

Property Value

Type	Description
String

Exception

Gets the exception that failed the worker, or null if either no exception was thrown, or it was thrown but the worker caught and did not rethrow it.

Exception can be null even if the worker fails - this happens when the worker notices an error condition without an exception having been thrown, e.g. testing for a null argument, logs the error, and return OutcomeStatus.Error or OutcomeStatus.Fatal.

Declaration

Exception Exception { get; }

Property Value

Type	Description
Exception	The exception.

InnerStatuses

Gets the inner statuses, which only consists of failure statuses, or an empty list.

Declaration

IImmutableList<IOutcomeStatus> InnerStatuses { get; }

Property Value

Type	Description
IImmutableList<IOutcomeStatus>

IsCanceled

Gets a value indicating whether the status is canceled.

Declaration

bool IsCanceled { get; }

Property Value

Type	Description
Boolean	true if this instance is canceled; otherwise, false.

IsCompleted

Gets a value indicating whether this instance is completed, i.e. is in a final state.

Declaration

bool IsCompleted { get; }

Property Value

Type	Description
Boolean	true if this instance is completed; otherwise, false.

IsError

Gets a value indicating whether the status is an error.

Declaration

bool IsError { get; }

Property Value

Type	Description
Boolean	true if this instance is an error; otherwise, false.

IsFailed

Gets a value indicating whether the status is in a failed completed state.

Declaration

bool IsFailed { get; }

Property Value

Type	Description
Boolean	true if this instance is Canceled, Error, or Fatal; otherwise, false.

IsFatal

Gets a value indicating whether the status has fatally faulted.

Declaration

bool IsFatal { get; }

Property Value

Type	Description
Boolean	true if this instance has fatally faulted; otherwise, false.

IsSucceeded

Gets a value indicating whether the status has succeeded.

Declaration

bool IsSucceeded { get; }

Property Value

Type	Description
Boolean	true if this instance has succeeded; otherwise, false.

Message

Gets the message.

Declaration

string Message { get; }

Property Value

Type	Description
String

Name

Gets the name of the status.

Declaration

string Name { get; }

Property Value

Type	Description
String

Ordinal

Gets the (0-based) OutcomeState ordinal.

Declaration

int Ordinal { get; }

Property Value

Type	Description
Int32

Methods

ThrowOnFailure()

Throws an exception if the State is a failure state.

Declaration

void ThrowOnFailure()

Exceptions

Type	Condition
InvalidOperationException	State

ToLongString()

Returns a String that describes this instance in detail.

Declaration

string ToLongString()

Returns

Type	Description
String

ToString()

Returns a String that represents this instance.

Declaration

string ToString()

Returns

Type	Description
String

See Also

OutcomeStatus

ProgressStatus

WorkerParentStatus