Assembly: OptimaJet.Workflow.Core

Class GlobalParameterEntity

OptimaJet.Workflow.Core.Entities.GlobalParameterEntity

Represents the persisted data for a global parameter.

Namespace: OptimaJet.Workflow.Core.Entities

public class GlobalParameterEntity : IEntity

Type Hierarchy

  • GlobalParameterEntity Current type

Properties

public Guid Id { get; set; } #
Gets or sets the unique identifier of the global parameter record.
public string Type { get; set; } #
Gets or sets the logical type used to group the global parameter.
public string Name { get; set; } #
Gets or sets the name that identifies the global parameter within its logical type and tenant scope.
public string Value { get; set; } #
Gets or sets the serialized value of the global parameter.
public string TenantId { get; set; } #
Gets or sets the tenant identifier for the global parameter, or null for a shared global parameter.

Methods

public object GetValue(string key) #
Gets the value of the property identified by key.

Parameters

Name
Type
Description
key
String
The name of GlobalParameterEntity.Id, GlobalParameterEntity.Type, GlobalParameterEntity.Name, GlobalParameterEntity.Value, or GlobalParameterEntity.TenantId.

Returns

Type
Description
Object
The value of the property selected by key.

Exceptions

Type
Description
ColumnNotExistsException
key does not match the name of a supported property.
public void SetValue(string key, object value) #
Sets the value of the property identified by key.

Parameters

Name
Type
Description
key
String
The name of GlobalParameterEntity.Id, GlobalParameterEntity.Type, GlobalParameterEntity.Name, GlobalParameterEntity.Value, or GlobalParameterEntity.TenantId.
value
Object
The value to assign. A value for GlobalParameterEntity.Id must be a Guid; a value that is not a string for any other supported property is assigned as null.

Exceptions

Type
Description
ColumnNotExistsException
key does not match the name of a supported property.
InvalidCastException
key identifies GlobalParameterEntity.Id and value is not null and is not a Guid.
NullReferenceException
key identifies GlobalParameterEntity.Id and value is null.