Assembly: OptimaJet.Workflow.Core

Class SchemeEntity

OptimaJet.Workflow.Core.Entities.SchemeEntity

Represents a persistence entity that stores a workflow scheme definition and its inlining, tag, and tenant metadata.

Namespace: OptimaJet.Workflow.Core.Entities

public class SchemeEntity : IEntity

Type Hierarchy

  • SchemeEntity Current type

Properties

public Guid Id { get; set; } #
Gets or sets the identifier of the stored workflow scheme record.
public string Code { get; set; } #
Gets or sets the code used to select the workflow scheme within its tenant scope.
public string Scheme { get; set; } #
Gets or sets the serialized workflow scheme definition.
public bool CanBeInlined { get; set; } #
Gets or sets a value indicating whether the workflow scheme can be inlined into another workflow scheme.
public string InlinedSchemes { get; set; } #
Gets or sets the JSON-serialized list of codes for workflow schemes inlined into this workflow scheme.
public string Tags { get; set; } #
Gets or sets the JSON-serialized list of tags assigned to the workflow scheme.
public string TenantId { get; set; } #
Gets or sets the tenant identifier for the workflow scheme, or null for a shared workflow scheme.

Methods

public List<string> GetInlinedSchemes() #
Deserializes SchemeEntity.InlinedSchemes into a list of inlined workflow scheme codes.

Returns

Type
Description
List<String>
The deserialized workflow scheme codes, or an empty list when SchemeEntity.InlinedSchemes is null.
public object GetValue(string key) #
Gets the value of the property identified by key.

Parameters

Name
Type
Description
key
String
The case-sensitive name of SchemeEntity.Id, SchemeEntity.Code, SchemeEntity.Scheme, SchemeEntity.CanBeInlined, SchemeEntity.InlinedSchemes, SchemeEntity.Tags, or SchemeEntity.TenantId.

Returns

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

Exceptions

Type
Description
ColumnNotExistsException
key does not identify 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 case-sensitive name of SchemeEntity.Id, SchemeEntity.Code, SchemeEntity.Scheme, SchemeEntity.CanBeInlined, SchemeEntity.InlinedSchemes, SchemeEntity.Tags, or SchemeEntity.TenantId.
value
Object
The value to assign. A value for SchemeEntity.Id must be a Guid, and a value for SchemeEntity.CanBeInlined must be a bool. For the remaining properties, a value that is not a string is assigned as null.

Exceptions

Type
Description
ColumnNotExistsException
key does not identify a supported property.
InvalidCastException
key identifies SchemeEntity.Id or SchemeEntity.CanBeInlined, and value is not null and has an incompatible type.
NullReferenceException
key identifies SchemeEntity.Id or SchemeEntity.CanBeInlined, and value is null.