Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class Loop

OptimaJet.Workflow.Plugins.LoopsPlugin.Loop

Namespace: OptimaJet.Workflow.Plugins.LoopsPlugin

[JsonConverter(typeof(NewtonsoftLoopTypeConverter))]
[JsonConverter(typeof(SystemTextLoopTypeConverter))]
public abstract class Loop

Inheritance

  • System.Object

Attributes

  • Newtonsoft.Json.JsonConverterAttribute: Attribute of type Newtonsoft.Json.JsonConverterAttribute
  • System.Text.Json.Serialization.JsonConverterAttribute: Attribute of type System.Text.Json.Serialization.JsonConverterAttribute

Properties

Name
Type
LoopType #
String

Methods

protected abstract bool ConditionValid(LoopCounter counter) #

Parameters

Name
Type
Description
counter
LoopCounter

Returns

Type
Description
Boolean
public abstract Task InitAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task
protected abstract LoopCounter DoStep(LoopCounter counter, StepsType stepType) #

Parameters

Name
Type
Description
counter
LoopCounter
stepType
StepsType

Returns

Type
Description
LoopCounter
public static Task<Loop> GetLoopAsync(ProcessInstance processInstance, string loopName) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
loopName
String

Returns

Type
Description
Task<Loop>
public Task SetStateAsync(ProcessInstance processInstance, LoopState loopState) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
loopState
LoopState

Returns

Type
Description
Task
public Task<LoopState> GetStateAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task<LoopState>
protected Task<LoopCounter> GetCounterAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task<LoopCounter>
protected Task SetCounterAsync(ProcessInstance processInstance, LoopCounter counter) #

Parameters

Name
Type
Description
processInstance
ProcessInstance
counter
LoopCounter

Returns

Type
Description
Task
public Task<LoopCounter> GetPrevCounterValueAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task<LoopCounter>
public Task<LoopCounter> GetCurrentCounterValueAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task<LoopCounter>
public Task<LoopCounter> GetNextCounterValueAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task<LoopCounter>
public Task<bool> IsCompletedAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task<Boolean>
public Task DoStepAsyncAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task
public Task ContinueAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task
public Task BreakAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task
public Task CompleteAsync(ProcessInstance processInstance) #

Parameters

Name
Type
Description
processInstance
ProcessInstance

Returns

Type
Description
Task

Fields

public string Name #
public string StateParameterName #
public string CounterValueParameterName #
public StepsType StepType #
public bool IncludeLastValue #

Derived Types