Assembly: OptimaJet.Workflow.Core

Interface ITimerBuilder

OptimaJet.Workflow.Core.Model.Builder.ITimerBuilder

Provides fluent configuration for a TimerDefinition in a process scheme.

Namespace: OptimaJet.Workflow.Core.Model.Builder

public interface ITimerBuilder : IProcessDefinitionBuilder

Type Hierarchy

Methods

ITimerBuilder Ref(out TimerDefinition timerDefinition) #
Provides access to the current TimerDefinition.

Parameters

Name
Type
Description
timerDefinition
TimerDefinition
When this method returns, contains the current TimerDefinition.

Returns

Type
Description
ITimerBuilder
The current ITimerBuilder instance for method chaining.
ITimerBuilder Name(string name) #
Sets the timer name of the current TimerDefinition.

Parameters

Name
Type
Description
name
String
The timer name.

Returns

Type
Description
ITimerBuilder
The current ITimerBuilder instance for method chaining.
ITimerBuilder Interval(int interval) #
Configures the current TimerDefinition with a TimerType.Interval delay.

Parameters

Name
Type
Description
interval
Int32
The delay, in milliseconds.

Returns

Type
Description
ITimerBuilder
The current ITimerBuilder instance for method chaining.
ITimerBuilder Interval(TimeSpan interval) #
Configures the current TimerDefinition with a TimerType.Interval delay represented by a TimeSpan.

Parameters

Name
Type
Description
interval
TimeSpan
The delay to convert to the Workflow Engine interval format.

Returns

Type
Description
ITimerBuilder
The current ITimerBuilder instance for method chaining.
ITimerBuilder DateTime(DateTime dateTime) #
Configures the current TimerDefinition to execute at a specific date and time using TimerType.DateAndTime.

Parameters

Name
Type
Description
dateTime
DateTime
The date and time at which the timer should execute.

Returns

Type
Description
ITimerBuilder
The current ITimerBuilder instance for method chaining.
ITimerBuilder Date(DateTime date) #
Configures the current TimerDefinition to execute at midnight on a specific date using TimerType.Date.

Parameters

Name
Type
Description
date
DateTime
A DateTime whose date component specifies when the timer should execute.

Returns

Type
Description
ITimerBuilder
The current ITimerBuilder instance for method chaining.
ITimerBuilder Time(DateTime time) #
Configures the current TimerDefinition to execute at a specific time of day using TimerType.Time.

Parameters

Name
Type
Description
time
DateTime
A DateTime whose time-of-day component specifies when the timer should execute.

Returns

Type
Description
ITimerBuilder
The current ITimerBuilder instance for method chaining.
ITimerBuilder Expression(string expression) #
Configures the current TimerDefinition with a TimerType.Expression schedule.

Parameters

Name
Type
Description
expression
String
The C# expression whose result determines the timer's execution time.

Returns

Type
Description
ITimerBuilder
The current ITimerBuilder instance for method chaining.
ITimerBuilder Overridable() #
Sets TimerDefinition.NotOverrideIfExists to false so registration replaces an existing process timer with the same timer name.

Returns

Type
Description
ITimerBuilder
The current ITimerBuilder instance for method chaining.
ITimerBuilder NotOverridable() #
Sets TimerDefinition.NotOverrideIfExists to true so registration preserves an existing process timer with the same timer name.

Returns

Type
Description
ITimerBuilder
The current ITimerBuilder instance for method chaining.