Class ParametersCollection

Represent a collection of process's parameters

Inheritance

↳ object

    ↳ ParametersCollection

Implements

IEnumerable<ParameterDefinitionWithValue>

IEnumerable

Inherited Members

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Core.Model

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public sealed class ParametersCollection : IEnumerable<ParameterDefinitionWithValue>, IEnumerable

Constructors

ParametersCollection(List<ParameterDefinitionWithValue>, ProcessInstance)

Declaration

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

Parameters

Type	Name	Description
List<ParameterDefinitionWithValue>	parameters
ProcessInstance	owner

ParametersCollection(IEnumerable<ParameterDefinitionWithValue>, ProcessInstance)

Declaration

public ParametersCollection(IEnumerable<ParameterDefinitionWithValue> parameters, ProcessInstance owner)

Parameters

Type	Name	Description
IEnumerable<ParameterDefinitionWithValue>	parameters
ProcessInstance	owner

ParametersCollection(ProcessInstance)

Declaration

public ParametersCollection(ProcessInstance owner)

Parameters

Type	Name	Description
ProcessInstance	owner

Methods

GetEnumerator()

Declaration

public IEnumerator<ParameterDefinitionWithValue> GetEnumerator()

Returns

Type	Description
IEnumerator<ParameterDefinitionWithValue>

AddParameter(ParameterDefinitionWithValue)

Adds parameter to process parameters collection

Declaration

public void AddParameter(ParameterDefinitionWithValue parameter)

Parameters

Type	Name	Description
ParameterDefinitionWithValue	parameter	Parameter with value <xref href="OptimaJet.Workflow.Core.Model.ParameterDefinitionWithValue" data-throw-if-not-resolved="false"></xref>

AddParameters(IEnumerable<ParameterDefinitionWithValue>)

Adds parameters to process parameters collection

Declaration

public void AddParameters(IEnumerable<ParameterDefinitionWithValue> parameters)

Parameters

Type	Name	Description
IEnumerable<ParameterDefinitionWithValue>	parameters	Collection of parameters with value <xref href="OptimaJet.Workflow.Core.Model.ParameterDefinitionWithValue" data-throw-if-not-resolved="false"></xref>

ReplaceParameters(List<ParameterDefinitionWithValue>)

Replace parameters collection by new value

Declaration

public void ReplaceParameters(List<ParameterDefinitionWithValue> parameters)

Parameters

Type	Name	Description
List<ParameterDefinitionWithValue>	parameters	>Collection of parameters with value <xref href="OptimaJet.Workflow.Core.Model.ParameterDefinitionWithValue" data-throw-if-not-resolved="false"></xref>

IsParameterExisting(string)

Checks that the parameter whether exists or not

Declaration

public bool IsParameterExisting(string name)

Parameters

Type	Name	Description
string	name	Name of the parameter

Returns

Type	Description
bool	true if exists

GetParameter(string)

Returns parameter with value ParameterDefinitionWithValue with specific name

Declaration

public ParameterDefinitionWithValue GetParameter(string name)

Parameters

Type	Name	Description
string	name	Name of the parameter

Returns

Type	Description
ParameterDefinitionWithValue	Parameter with value <xref href="OptimaJet.Workflow.Core.Model.ParameterDefinitionWithValue" data-throw-if-not-resolved="false"></xref>

GetParameterAsync(string)

Returns parameter with value ParameterDefinitionWithValue with specific name (Async version)

Declaration

public Task<ParameterDefinitionWithValue> GetParameterAsync(string name)

Parameters

Type	Name	Description
string	name	Name of the parameter

Returns

Type	Description
Task<ParameterDefinitionWithValue>	Parameter with value <xref href="OptimaJet.Workflow.Core.Model.ParameterDefinitionWithValue" data-throw-if-not-resolved="false"></xref>

GetParameter<T>(string)

Returns parameter's value by specific name

Declaration

public T GetParameter<T>(string name)

Parameters

Type	Name	Description
string	name	Name of the parameter

Returns

Type	Description
{T}	Value of the parameter

GetParameterAsync<T>(string)

Returns parameter's value by specific name (Async version)

Declaration

public Task<T> GetParameterAsync<T>(string name)

Parameters

Type	Name	Description
string	name	Name of the parameter

Returns

Type	Description
Task<T>	Value of the parameter

SetParameter<T>(string, T, ParameterPurpose)

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

Declaration

public void SetParameter<T>(string name, T value, ParameterPurpose purposeIfMissing = ParameterPurpose.Temporary)

Parameters

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

SetParameterAsync<T>(string, T, ParameterPurpose)

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.

Declaration

public Task SetParameterAsync<T>(string name, T value, ParameterPurpose purposeIfMissing = ParameterPurpose.Temporary)

Parameters

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

Returns

Type	Description
Task

SetImplicitSerializedParameter(string, string, ParameterPurpose)

Sets implicit parameter using it's json serialized value

Declaration

public void SetImplicitSerializedParameter(string name, string value, ParameterPurpose purposeIfMissing = ParameterPurpose.Temporary)

Parameters

Type	Name	Description
string	name	Name of the parameter
string	value	JSON serialized value of implicit parameter
ParameterPurpose	purposeIfMissing	Parameter purpose

RemoveParameter(string, bool)

Set null to process parameter value

Declaration

public void RemoveParameter(string name, bool removeFromCollection = false)

Parameters

Type	Name	Description
string	name	Parameter name
bool	removeFromCollection	If true physically remove <xref href="OptimaJet.Workflow.Core.Model.ParameterDefinitionWithValue" data-throw-if-not-resolved="false"></xref> from collection

InitPersistenceParametersFromScheme()

Declaration

public void InitPersistenceParametersFromScheme()

Extension Methods

• TaskExtensions.ParallelForEachAsync<T>(IEnumerable<T>, Func<T, Task>, CancellationToken, int?)
• Extensions.CastAs<T>(object)
• Extensions.ExtendedEquals(object, object)
• Extensions.TryCast<T>(object, out T)