Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Interface ITimerBuilder

OptimaJet.Workflow.Core.Model.Builder.ITimerBuilder

Represents a builder for configuring a timer definition.

Namespace: OptimaJet.Workflow.Core.Model.Builder

public interface ITimerBuilder : IProcessDefinitionBuilder

Methods

ITimerBuilder Ref(out TimerDefinition timerDefinition) #
Sets the reference to the current TimerDefinition for further configuration.

Parameters

Name
Type
Description
timerDefinition
TimerDefinition
The variable that will hold the current TimerDefinition.

Returns

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

Parameters

Name
Type
Description
name
String
The name of the timer.

Returns

Type
Description
ITimerBuilder
Returns the current ITimerBuilder instance for chaining method calls.
ITimerBuilder Interval(int interval) #
Sets the interval in seconds for the timer.

Parameters

Name
Type
Description
interval
Int32
The interval in seconds.

Returns

Type
Description
ITimerBuilder
Returns the current ITimerBuilder instance for chaining method calls.
ITimerBuilder Interval(TimeSpan interval) #
Sets the interval using a TimeSpan.

Parameters

Name
Type
Description
interval
TimeSpan
The interval as a TimeSpan.

Returns

Type
Description
ITimerBuilder
Returns the current ITimerBuilder instance for chaining method calls.
ITimerBuilder DateTime(DateTime dateTime) #
Sets the specific date and time when the timer should trigger.

Parameters

Name
Type
Description
dateTime
DateTime
The date and time to trigger the timer.

Returns

Type
Description
ITimerBuilder
Returns the current ITimerBuilder instance for chaining method calls.
ITimerBuilder Date(DateTime date) #
Sets the specific date when the timer should trigger.

Parameters

Name
Type
Description
date
DateTime
The date to trigger the timer.

Returns

Type
Description
ITimerBuilder
Returns the current ITimerBuilder instance for chaining method calls.
ITimerBuilder Time(DateTime time) #
Sets the specific time when the timer should trigger.

Parameters

Name
Type
Description
time
DateTime
The time to trigger the timer.

Returns

Type
Description
ITimerBuilder
Returns the current ITimerBuilder instance for chaining method calls.
ITimerBuilder Expression(string expression) #
Sets an expression to define when the timer should trigger.

Parameters

Name
Type
Description
expression
String
The expression determining the trigger time.

Returns

Type
Description
ITimerBuilder
Returns the current ITimerBuilder instance for chaining method calls.
ITimerBuilder Overridable() #
Allows the timer to be overridden if it already exists.

Returns

Type
Description
ITimerBuilder
Returns the current ITimerBuilder instance for chaining method calls.
ITimerBuilder NotOverridable() #
Prevents the timer from being overridden if it already exists.

Returns

Type
Description
ITimerBuilder
Returns the current ITimerBuilder instance for chaining method calls.