Class ProcessParameterMemoryStore

In memory store for process parameter values.

Inheritance

System.Object

ProcessParameterMemoryStore

Implements

IProcessParameterStore

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Terrasoft.Core.Process

Assembly: Terrasoft.Core.dll

Syntax

public class ProcessParameterMemoryStore : IInternalProcessParameterStore, IProcessParameterStore

Constructors

ProcessParameterMemoryStore()

Declaration

public ProcessParameterMemoryStore()

Properties

ParameterInfoLocalStore

Gets the repository of the process parameter data.

Declaration

public Dictionary<string, ProcessParameterInfo> ParameterInfoLocalStore { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, ProcessParameterInfo>

ParameterInfoPathes

Gets the set of paths by which you can retrieve process parameter data.

Declaration

public HashSet<string> ParameterInfoPathes { get; }

Property Value

Type	Description
System.Collections.Generic.HashSet<System.String>

ParameterStores

Gets the set of the repositories where stores the process parameter values.

Declaration

public Dictionary<Type, object> ParameterStores { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.Type, System.Object>

Methods

ContainsParameterPath(Guid, String)

Determines whether a parameter path is in the repository.

Declaration

public bool ContainsParameterPath(Guid processUId, string parameterPath)

Parameters

Type	Name	Description
System.Guid	processUId	Process UId.
System.String	parameterPath	Parameter path.

Returns

Type	Description
System.Boolean	`true`, if repository contains parameter path, otherwise - `false`.

FindParameterInfo(Guid, String)

Finds for process parameter data.

Declaration

public ProcessParameterInfo FindParameterInfo(Guid processUId, string parameterPath)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.

Returns

Type	Description
ProcessParameterInfo	Instance of the ProcessParameterInfo type or `null`, if no data is found.

FindParameterValue(Guid, String)

Extracts the value of any type by generated key. The key is generated based on the value of the processUId Id and the value of the parameterPath parameter.

Declaration

public object FindParameterValue(Guid processUId, string parameterPath)

Parameters

Type	Name	Description
System.Guid	processUId	Business process UId.
System.String	parameterPath	Path to the parameter value that must be retrieved.

Returns

Type	Description
System.Object	Parameter value or `null`, if parameter not found.

GetParameterInfo(Guid, String)

Returns the data of the process parameter. If no data is found, an exception is thrown.

Declaration

public ProcessParameterInfo GetParameterInfo(Guid processUId, string parameterPath)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.

Returns

Type	Description
ProcessParameterInfo	Instance of the ProcessParameterInfo type.

Exceptions

Type	Condition
ItemNotFoundException	If the process parameter data is not found.

GetParameterInfoPathes(Guid)

Returns the set of paths by which you can retrieve data of the process parameter.

Declaration

public HashSet<string> GetParameterInfoPathes(Guid processUId)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.

Returns

Type	Description
System.Collections.Generic.HashSet<System.String>	A hash table that contains a set of paths to process parameter data.

GetParametersMapInfo(Guid)

Returns the process parameters association table.

Declaration

public Dictionary<string, ProcessParameterInfo> GetParametersMapInfo(Guid processUId)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, ProcessParameterInfo>

GetParameterValue(Guid, String)

Extracts the value of any type by generated key. The key is generated based on the value of the processUId Id and the value of the parameterPath parameter.

Declaration

public object GetParameterValue(Guid processUId, string parameterPath)

Parameters

Type	Name	Description
System.Guid	processUId	Business process UId.
System.String	parameterPath	Path to the parameter value that must be retrieved.

Returns

Type	Description
System.Object	Parameter value.

Exceptions

Type	Condition
ItemNotFoundException	Throws when parameter value does not exist in repository.

GetProcessParameterPathes(Guid)

Returns the set of paths by which you can retrieve the values of the process parameters.

Declaration

public HashSet<string> GetProcessParameterPathes(Guid processUId)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.

Returns

Type	Description
System.Collections.Generic.HashSet<System.String>	A hash table that contains a set of paths to process parameter values.

RemoveParametersInfo(Guid)

The method is not implemented.

Declaration

public void RemoveParametersInfo(Guid processUId)

Parameters

Type	Name	Description
System.Guid	processUId

RemoveParameterValues(Guid)

The method is not implemented.

Declaration

public void RemoveParameterValues(Guid processUId)

Parameters

Type	Name	Description
System.Guid	processUId

SaveParameterInfo(Guid, String, ProcessParameterInfo)

Saves the parameter data of the specified process.

Declaration

public void SaveParameterInfo(Guid processUId, string parameterPath, ProcessParameterInfo parameterInfo)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
ProcessParameterInfo	parameterInfo	Process parameter data.

SaveParametersInfo(Guid, IDictionary<String, ProcessParameterInfo>)

Saves data for the parameters of the specified process.

Declaration

public void SaveParametersInfo(Guid processUId, IDictionary<string, ProcessParameterInfo> pathParametersInfo)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.Collections.Generic.IDictionary<System.String, ProcessParameterInfo>	pathParametersInfo	A list of key/value pairs, where the key is the path to the parameter, and the value is the data of the process parameter.

SetParameterValue(Guid, String, Boolean)

Sets the value of the System.Boolean type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public void SetParameterValue(Guid processUId, string parameterPath, bool value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
System.Boolean	value	The current value of the parameter type with System.Boolean.

SetParameterValue(Guid, String, DateTime)

Sets the value of the System.DateTime type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public void SetParameterValue(Guid processUId, string parameterPath, DateTime value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
System.DateTime	value	The current value of the parameter type with System.DateTime.

SetParameterValue(Guid, String, Decimal)

Sets the value of the System.Decimal type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public void SetParameterValue(Guid processUId, string parameterPath, decimal value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
System.Decimal	value	The current value of the parameter type with System.Decimal.

SetParameterValue(Guid, String, Double)

Sets the value of the System.Double type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public void SetParameterValue(Guid processUId, string parameterPath, double value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
System.Double	value	The current value of the parameter type with System.Double.

SetParameterValue(Guid, String, Enum)

Sets the value of the System.Enum type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public void SetParameterValue(Guid processUId, string parameterPath, Enum value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
System.Enum	value	The current value of the parameter type with System.Enum.

SetParameterValue(Guid, String, Guid)

Sets the value of the System.Guid type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public void SetParameterValue(Guid processUId, string parameterPath, Guid value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
System.Guid	value	The current value of the parameter type with System.Guid.

SetParameterValue(Guid, String, Int32)

Sets the value of the System.Int32 type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public void SetParameterValue(Guid processUId, string parameterPath, int value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
System.Int32	value	The current value of the parameter type with System.Int32.

SetParameterValue(Guid, String, String)

Sets the value of the System.String type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public void SetParameterValue(Guid processUId, string parameterPath, string value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
System.String	value	The current value of the parameter type with System.String.

SetParameterValue(Guid, String, ISerializableObject)

Sets the value of the ISerializableObject type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public void SetParameterValue(Guid processUId, string parameterPath, ISerializableObject value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
ISerializableObject	value	The current value of the parameter type with LocalizableString.

SetParameterValue(Guid, String, LocalizableString)

Sets the value of the LocalizableString type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public void SetParameterValue(Guid processUId, string parameterPath, LocalizableString value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the process parameter data.
LocalizableString	value	The current value of the parameter type with LocalizableString.

SetParameterValue<T>(Guid, String, T)

Declaration

public void SetParameterValue<T>(Guid processUId, string parameterPath, T value)

Parameters

Type	Name	Description
System.Guid	processUId
System.String	parameterPath
T	value

Type Parameters

Name	Description
T

TryGetParameterValue(Guid, String, out Boolean)

Tries to get the value of the System.Boolean type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public bool TryGetParameterValue(Guid processUId, string parameterPath, out bool value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the value of the parameter to be retrieved.
System.Boolean	value	The current value of the parameter type with System.Boolean.

Returns

Type	Description
System.Boolean	`true`, if the repository contains the value of the parameter on the generated key; otherwise - `false`.

TryGetParameterValue(Guid, String, out DateTime)

Tries to get the value of the System.DateTime type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public bool TryGetParameterValue(Guid processUId, string parameterPath, out DateTime value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the value of the parameter to be retrieved.
System.DateTime	value	The current value of the parameter type with System.DateTime.

Returns

Type	Description
System.Boolean	`true`, if the repository contains the value of the parameter on the generated key; otherwise - `false`.

TryGetParameterValue(Guid, String, out Decimal)

Tries to get the value of the System.Decimal type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public bool TryGetParameterValue(Guid processUId, string parameterPath, out decimal value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the value of the parameter to be retrieved.
System.Decimal	value	The current value of the parameter type with System.Decimal.

Returns

Type	Description
System.Boolean	`true`, if the repository contains the value of the parameter on the generated key; otherwise - `false`.

TryGetParameterValue(Guid, String, out Double)

Tries to get the value of the System.Double type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public bool TryGetParameterValue(Guid processUId, string parameterPath, out double value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the value of the parameter to be retrieved.
System.Double	value	The current value of the parameter type with System.Double.

Returns

Type	Description
System.Boolean	`true`, if the repository contains the value of the parameter on the generated key; otherwise - `false`.

TryGetParameterValue(Guid, String, out Enum)

Tries to get the value of the System.Enum type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public bool TryGetParameterValue(Guid processUId, string parameterPath, out Enum value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the value of the parameter to be retrieved.
System.Enum	value	The current value of the parameter type with System.Enum.

Returns

Type	Description
System.Boolean	`true`, if the repository contains the value of the parameter on the generated key; otherwise - `false`.

TryGetParameterValue(Guid, String, out Guid)

Tries to get the value of the System.Guid type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public bool TryGetParameterValue(Guid processUId, string parameterPath, out Guid value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the value of the parameter to be retrieved.
System.Guid	value	The current value of the parameter type with System.Guid.

Returns

Type	Description
System.Boolean	`true`, if the repository contains the value of the parameter on the generated key; otherwise - `false`.

TryGetParameterValue(Guid, String, out Int32)

Tries to get the value of the System.Int32 type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public bool TryGetParameterValue(Guid processUId, string parameterPath, out int value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the value of the parameter to be retrieved.
System.Int32	value	The current value of the parameter type with System.Int32.

Returns

Type	Description
System.Boolean	`true`, if the repository contains the value of the parameter on the generated key; otherwise - `false`.

TryGetParameterValue(Guid, String, out String)

Tries to get the value of the System.String type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public bool TryGetParameterValue(Guid processUId, string parameterPath, out string value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the value of the parameter to be retrieved.
System.String	value	The current value of the parameter type with System.String.

Returns

Type	Description
System.Boolean	`true`, if the repository contains the value of the parameter on the generated key; otherwise - `false`.

TryGetParameterValue(Guid, String, out ISerializableObject)

Attempts to retrieve the value of a parameter of the ISerializableObject type on the generated key. The key is formed by the value of the identifier processUId and the value of the parameter parameterPath.

Declaration

public bool TryGetParameterValue(Guid processUId, string parameterPath, out ISerializableObject value)

Parameters

Type	Name	Description
System.Guid	processUId	The process unique identifier.
System.String	parameterPath	The path to the value of the parameter to be retrieved.
ISerializableObject	value	The value of the parameter of the ISerializableObject type.

Returns

Type	Description
System.Boolean	`true`, if the store contains the value of the parameter on the generated key; otherwise - `false`.

TryGetParameterValue(Guid, String, out LocalizableString)

Tries to get the value of the LocalizableString type parameter by generated key. The key is formed by the value of the identifier processUId and by the value of the parameter path parameterPath.

Declaration

public bool TryGetParameterValue(Guid processUId, string parameterPath, out LocalizableString value)

Parameters

Type	Name	Description
System.Guid	processUId	Unique identifier of the process.
System.String	parameterPath	The path to the value of the parameter to be retrieved.
LocalizableString	value	The current value of the parameter type with LocalizableString.