Interface IStarter

Namespace

Tlabs.JobCntrl.Model

Assembly

Tlabs.JobCntrl.dll

JobControl Starter to start the run of an Job.

public interface IStarter : IModel, IDisposable

Inherited Members

IModel.Name

IModel.Description

IModel.Properties

IDisposable.Dispose()

Extension Methods

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

Properties

Enabled

Starter enable status

bool Enabled { get; set; }

Property Value

bool

Methods

DoActivate(IReadOnlyDictionary<string, object?>?)

Manually activate the Starter.

bool DoActivate(IReadOnlyDictionary<string, object?>? activationProps)

Parameters

activationProps IReadOnlyDictionary<string, object>

(Optional) activation properties to be passed to the Job(s) being started.

Returns

bool

true if actually at least one jobs has been activated, false if no job at all was activated (because the starter was disabled or no jobs are configured...

Initialize(string, string, IReadOnlyDictionary<string, object?>)

Initialize a Starter

IStarter Initialize(string name, string description, IReadOnlyDictionary<string, object?> properties)

Parameters

name string

Unique Starter name/ID

description string

Starter description

properties IReadOnlyDictionary<string, object>

Properties dictionary

Returns

IStarter

Should return this.(Utility to create instances like: var triggger= new Starter().Initialize(name, description, properties);)

Remarks

Implementations should initialize a Starter as 'disabled' (i.e. IStarter.enabled == false) in order to let the runtime enable Starters after configuration loading.

Events

Activate

Event to be registered by Job(s)

event StarterActivator Activate

Event Type

StarterActivator