Skip to main content

Class Loop

Inheritance​

↳ object

    ↳ Loop

        ↳ LoopFor<TStartEndValues, TStep>

        ↳ LoopForeach

Inherited Members​

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Plugins.LoopsPlugin

Assembly: OptimaJet.Workflow.Core.dll

Syntax
[JsonConverter(typeof(LoopTypeConverter))]
public abstract class Loop

Properties​

LoopType​

Declaration
public abstract string LoopType { get; }
Property value
TypeDescription
string

Methods​

ConditionValid(LoopCounter)​

Declaration
protected abstract bool ConditionValid(LoopCounter counter)
Parameters
TypeNameDescription
LoopCountercounter
Returns
TypeDescription
bool

InitAsync(ProcessInstance)​

Declaration
public abstract Task InitAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task

DoStep(LoopCounter, StepsType)​

Declaration
protected abstract LoopCounter DoStep(LoopCounter counter, StepsType stepType)
Parameters
TypeNameDescription
LoopCountercounter
StepsTypestepType
Returns
TypeDescription
LoopCounter

GetLoopAsync(ProcessInstance, string)​

Declaration
public static Task<Loop> GetLoopAsync(ProcessInstance processInstance, string loopName)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
stringloopName
Returns
TypeDescription
Task<Loop>

SetStateAsync(ProcessInstance, LoopState)​

Declaration
public Task SetStateAsync(ProcessInstance processInstance, LoopState loopState)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
LoopStateloopState
Returns
TypeDescription
Task

GetStateAsync(ProcessInstance)​

Declaration
public Task<LoopState> GetStateAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task<LoopState>

GetCounterAsync(ProcessInstance)​

Declaration
protected Task<LoopCounter> GetCounterAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task<LoopCounter>

SetCounterAsync(ProcessInstance, LoopCounter)​

Declaration
protected Task SetCounterAsync(ProcessInstance processInstance, LoopCounter counter)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
LoopCountercounter
Returns
TypeDescription
Task

GetPrevCounterValueAsync(ProcessInstance)​

Declaration
public Task<LoopCounter> GetPrevCounterValueAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task<LoopCounter>

GetCurrentCounterValueAsync(ProcessInstance)​

Declaration
public Task<LoopCounter> GetCurrentCounterValueAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task<LoopCounter>

GetNextCounterValueAsync(ProcessInstance)​

Declaration
public Task<LoopCounter> GetNextCounterValueAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task<LoopCounter>

IsCompletedAsync(ProcessInstance)​

Declaration
public Task<bool> IsCompletedAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task<bool>

DoStepAsyncAsync(ProcessInstance)​

Declaration
public Task DoStepAsyncAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task

ContinueAsync(ProcessInstance)​

Declaration
public Task ContinueAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task

BreakAsync(ProcessInstance)​

Declaration
public Task BreakAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task

CompleteAsync(ProcessInstance)​

Declaration
public Task CompleteAsync(ProcessInstance processInstance)
Parameters
TypeNameDescription
ProcessInstanceprocessInstance
Returns
TypeDescription
Task

Fields​

Name​

Declaration
public string Name
Returns
TypeDescription
string

StateParameterName​

Declaration
public string StateParameterName
Returns
TypeDescription
string

CounterValueParameterName​

Declaration
public string CounterValueParameterName
Returns
TypeDescription
string

StepType​

Declaration
public StepsType StepType
Returns
TypeDescription
StepsType

IncludeLastValue​

Declaration
public bool IncludeLastValue
Returns
TypeDescription
bool

Extension Methods​