Class InputPortStateExtensions

Static helper methods for InputPortState.

Inheritance
Object
InputPortStateExtensions
Namespace: actionETL
Assembly: actionETL.dll
Syntax
public static class InputPortStateExtensions

Methods

IsActive(InputPortState)

Extension method that returns true if the state is active (i.e. ActiveAndUpstreamActive, or ActiveAndUpstreamSucceeded; otherwise, false.

Declaration
public static bool IsActive(this InputPortState inputPortState)
Parameters
Type Name Description
InputPortState inputPortState

Input port state.
Returns
Type Description
Boolean

IsCompleted(InputPortState)

Extension method that returns true if the state is completed (i.e. at least Succeeded); otherwise, false.

Declaration
public static bool IsCompleted(this InputPortState inputPortState)
Parameters
Type Name Description
InputPortState inputPortState

Input port state.
Returns
Type Description
Boolean

IsFailed(InputPortState)

Extension method that returns true if the state is failed (i.e. Error or Fatal); otherwise, false.

Note that IsFailed does not include the Canceled state, since Canceled is not a final port state.

Declaration
public static bool IsFailed(this InputPortState inputPortState)
Parameters
Type Name Description
InputPortState inputPortState

Input port state.
Returns
Type Description
Boolean

ToOutcomeStatus(InputPortState)

Extension method that returns the corresponding OutcomeStatus.

Declaration
public static OutcomeStatus ToOutcomeStatus(this InputPortState inputPortState)
Parameters
Type Name Description
InputPortState inputPortState

Input port state.
Returns
Type Description
OutcomeStatus
Exceptions
Type Condition
InvalidOperationException

ToOutcomeStatus() is only defined where the completed state is known

ToProgressStatus(InputPortState)

Extension method that returns the corresponding ProgressStatus.

Declaration
public static ProgressStatus ToProgressStatus(this InputPortState inputPortState)
Parameters
Type Name Description
InputPortState inputPortState

Input port state.
Returns
Type Description
ProgressStatus

See Also