Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class ParametersCollection

OptimaJet.Workflow.Core.Model.ParametersCollection

Represent a collection of process's parameters

Namespace: OptimaJet.Workflow.Core.Model

public sealed class ParametersCollection : IEnumerable<ParameterDefinitionWithValue>, IEnumerable

Inheritance

  • System.Object

Implemented Interfaces

  • System.Collections.Generic.IEnumerable{OptimaJet.Workflow.Core.Model.ParameterDefinitionWithValue}
  • System.Collections.IEnumerable

Constructors

public ParametersCollection(List<ParameterDefinitionWithValue> parameters, ProcessInstance owner) #

Parameters

Name
Type
Description
parameters
List<ParameterDefinitionWithValue>
owner
ProcessInstance
public ParametersCollection(IEnumerable<ParameterDefinitionWithValue> parameters, ProcessInstance owner) #

Parameters

Name
Type
Description
parameters
IEnumerable<ParameterDefinitionWithValue>
owner
ProcessInstance
public ParametersCollection(ProcessInstance owner) #

Parameters

Name
Type
Description
owner
ProcessInstance

Methods

public IEnumerator<ParameterDefinitionWithValue> GetEnumerator() #

Returns

Type
Description
IEnumerator<ParameterDefinitionWithValue>
public void AddParameter(ParameterDefinitionWithValue parameter) #
Adds parameter to process parameters collection

Parameters

Name
Type
Description
parameter
ParameterDefinitionWithValue
Parameter with value ParameterDefinitionWithValue
public void AddParameters(IEnumerable<ParameterDefinitionWithValue> parameters) #
Adds parameters to process parameters collection

Parameters

Name
Type
Description
parameters
IEnumerable<ParameterDefinitionWithValue>
Collection of parameters with value ParameterDefinitionWithValue
public void ReplaceParameters(List<ParameterDefinitionWithValue> parameters) #
Replace parameters collection by new value

Parameters

Name
Type
Description
parameters
List<ParameterDefinitionWithValue>
>Collection of parameters with value ParameterDefinitionWithValue
public bool IsParameterExisting(string name) #
Checks that the parameter whether exists or not

Parameters

Name
Type
Description
name
String
Name of the parameter

Returns

Type
Description
Boolean
true if exists
public ParameterDefinitionWithValue GetParameter(string name) #
Returns parameter with value ParameterDefinitionWithValue with specific name

Parameters

Name
Type
Description
name
String
Name of the parameter

Returns

Type
Description
ParameterDefinitionWithValue
Parameter with value ParameterDefinitionWithValue
public Task<ParameterDefinitionWithValue> GetParameterAsync(string name) #
Returns parameter with value ParameterDefinitionWithValue with specific name (Async version)

Parameters

Name
Type
Description
name
String
Name of the parameter

Returns

Type
Description
Task<ParameterDefinitionWithValue>
Parameter with value ParameterDefinitionWithValue
public T GetParameter<T>(string name) #
Returns parameter's value by specific name

Parameters

Name
Type
Description
name
String
Name of the parameter

Returns

Type
Description
{T}
Value of the parameter
public Task<T> GetParameterAsync<T>(string name) #
Returns parameter's value by specific name (Async version)

Parameters

Name
Type
Description
name
String
Name of the parameter

Returns

Type
Description
Task<T>
Value of the parameter
public void SetParameter<T>(string name, T value, ParameterPurpose purposeIfMissing = ParameterPurpose.Temporary) #
Set value of the parameter with specific name. If the definition of the parameter with specific name is absent in the scheme of the process ProcessDefinition.Parameters, there will be created Temporary parameter ParameterDefinition.Purpose with specified name

Parameters

Name
Type
Description
name
String
Name of the parameter
value
{T}
Value of the parameter
purposeIfMissing
ParameterPurpose
Set it to ParameterPurpose.Persistence if you want persist this parameter forcibly
public Task SetParameterAsync<T>(string name, T value, ParameterPurpose purposeIfMissing = ParameterPurpose.Temporary) #
Set value of the parameter with specific name. Async version If the definition of the parameter with specific name is absent in the scheme of the process ProcessDefinition.Parameters, there will be created Temporary parameter ParameterDefinition.Purpose with specified name.

Parameters

Name
Type
Description
name
String
Name of the parameter
value
{T}
Value of the parameter
purposeIfMissing
ParameterPurpose
Set it to ParameterPurpose.Persistence if you want persist this parameter forcibly

Returns

Type
Description
Task
public void SetImplicitSerializedParameter(string name, string value, ParameterPurpose purposeIfMissing = ParameterPurpose.Temporary) #
Sets implicit parameter using it's json serialized value

Parameters

Name
Type
Description
name
String
Name of the parameter
value
String
JSON serialized value of implicit parameter
purposeIfMissing
ParameterPurpose
Parameter purpose
public void RemoveParameter(string name, bool removeFromCollection = false) #
Set null to process parameter value

Parameters

Name
Type
Description
name
String
Parameter name
removeFromCollection
Boolean
If true physically remove ParameterDefinitionWithValue from collection
public void InitPersistenceParametersFromScheme() #