Assembly: OptimaJet.Workflow.Core

Class WorkflowFormEntity

OptimaJet.Workflow.Core.Entities.WorkflowFormEntity

Represents the persisted data for a WorkflowForm.

Namespace: OptimaJet.Workflow.Core.Entities

public class WorkflowFormEntity : IEntity

Type Hierarchy

  • WorkflowFormEntity Current type

Properties

public Guid Id { get; set; } #
Gets or sets the identifier of the persisted workflow form version.
public string Name { get; set; } #
Gets or sets the name that identifies the workflow form within its tenant scope.
public int Version { get; set; } #
Gets or sets the version number of the workflow form.
public DateTime CreationDate { get; set; } #
Gets or sets the date and time when the workflow form version was created.
public DateTime UpdatedDate { get; set; } #
Gets or sets the date and time when the workflow form version was last updated.
public string Definition { get; set; } #
Gets or sets the workflow form definition.
public int Lock { get; set; } #
Gets or sets the optimistic concurrency value for the workflow form version.
public string? TenantId { get; set; } #
Gets or sets the tenant identifier for the workflow form, or null for a shared workflow form.

Methods

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 a supported public property declared by WorkflowFormEntity.

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 case-sensitive name of a supported public property declared by WorkflowFormEntity.
value
Object
The value to assign. A value for WorkflowFormEntity.Id must be a Guid. Values for WorkflowFormEntity.CreationDate and WorkflowFormEntity.UpdatedDate must be a DateTime. Values for WorkflowFormEntity.Version and WorkflowFormEntity.Lock must be an int or long. For the remaining properties, a value that is not a string is assigned as null.

Exceptions

Type
Description
ColumnNotExistsException
key does not match the name of a supported property.
InvalidCastException
key identifies WorkflowFormEntity.Id, WorkflowFormEntity.CreationDate, or WorkflowFormEntity.UpdatedDate, and value is not null and has an incompatible type; or key identifies WorkflowFormEntity.Version or WorkflowFormEntity.Lock, and value is neither an int nor an long.
NullReferenceException
key identifies WorkflowFormEntity.Id, WorkflowFormEntity.CreationDate, or WorkflowFormEntity.UpdatedDate, and value is null.
public WorkflowForm ToModel() #
Creates a WorkflowForm with property values copied from this entity.

Returns

Type
Description
WorkflowForm
The WorkflowForm created from this entity.