Class Chained

Namespace

Tlabs.JobCntrl.Model.Intern.Starter

Assembly

Tlabs.JobCntrl.dll

Starter to activate when a preceding starter has completed.

public class Chained : BaseStarter, IStarter, IModel, IDisposable

Inheritance

object

BaseModel

BaseStarter

Chained

Implements

IStarter

IModel

IDisposable

Inherited Members

BaseStarter.RUN_PROPERTY_PREFIX

BaseStarter.isEnabled

BaseStarter.Initialize(string, string, IReadOnlyDictionary<string, object>)

BaseStarter.DoActivate(IReadOnlyDictionary<string, object>)

BaseStarter.Dispose(bool)

BaseStarter.Enabled

BaseStarter.Activate

BaseModel.InitBase(string, string, IReadOnlyDictionary<string, object>)

BaseModel.PropertyString(string)

BaseModel.PropertyString(string, string)

BaseModel.PropertyInt(string, int)

BaseModel.PropertyBool(string, bool)

BaseModel.PropertyEnum(string, Enum)

BaseModel.Dispose()

BaseModel.Name

BaseModel.Description

BaseModel.Properties

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ConfigUtilsExtensions.ApplyConfigurators<T>(T, IConfiguration, string?)

Remarks

The Chained operates in two general modes which are controlled with the property PROP_ACTIVATE_ON_PREV_STATUS:

Success
The starter activates only if ALL the preceding jobs succeeded. If the property PROP_PREVIOUS_ALLOW_FAIL is set to true, not all of the previous job results are required to succeed, but only the successful results get propagated.

Failure
Activates only if at least one of the previous job's results failed. In that case it propagates all failed job results with the job name.

Constructors

Chained()

public Chained()

Fields

PROP_ACTIVATE_ON_PREV_STATUS

Prop. name to specify the required result status of the predecessor.

public const string PROP_ACTIVATE_ON_PREV_STATUS = "Activate-On-Previous-Status"

Field Value

string

PROP_COMPLETED_STARTER

Prop. name for predecessor starter.

public const string PROP_COMPLETED_STARTER = "Completed-Starter"

Field Value

string

PROP_PREVIOUS_ALLOW_FAIL

Prop. name to specify failure behavior on predecessor.

public const string PROP_PREVIOUS_ALLOW_FAIL = "Prev-Allow-Fail"

Field Value

string

RPROP_PREVIOUS_RESULTS

Prop. name for redecessor result properties.

public const string RPROP_PREVIOUS_RESULTS = "$Previous-Results"

Field Value

string

RPROP_STARTER_COMPLETION

Prop. name for redecessor starter completion.

public const string RPROP_STARTER_COMPLETION = "$Starter-Completion"

Field Value

string

Methods

ChangeEnabledState(bool)

Internal enabled state change.

protected override void ChangeEnabledState(bool enabled)

Parameters

enabled bool

Remarks

Called from Enabled setter (hence must not call the enabled setter to set new state!).

InternalInit()

Internal Starter initalization.

protected override IStarter InternalInit()

Returns

IStarter

Remarks

Called from Initialize() after name, description and properties have been set.