# Class WorkflowForm

OptimaJet.Workflow.MSSQL.Models.WorkflowForm

Namespace: [OptimaJet.Workflow.MSSQL.Models](https://api.workflowengine.io/sql-server/OptimaJet.Workflow.MSSQL.Models/)

```csharp
public class WorkflowForm : DbObject<WorkflowFormEntity>
```

## Type Hierarchy

-   [DbObject<WorkflowFormEntity>](https://api.workflowengine.io/sql-server/OptimaJet.Workflow.DbPersistence/DbObject-TEntity/)
    -   WorkflowForm Current type

## Constructors

`public WorkflowForm(string schemaName, int commandTimeout)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `schemaName` | `String` |  |
| `commandTimeout` | `Int32` |  |

## Methods

`public Task<List<string>> GetFormNamesAsync(SqlConnection connection, string tenantId = null)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `connection` | `SqlConnection` |  |
| `tenantId` | `String` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<String>` |  |

`public Task<WorkflowFormEntity> GetFormAsync(SqlConnection connection, string name, int? version = null, string tenantId = null)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `connection` | `SqlConnection` |  |
| `name` | `String` |  |
| `version` | `Nullable<Int32>` |  |
| `tenantId` | `String` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<WorkflowFormEntity>` |  |

`public Task<List<int>> GetFormVersionsAsync(SqlConnection connection, string name, string tenantId = null)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `connection` | `SqlConnection` |  |
| `name` | `String` |  |
| `tenantId` | `String` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<Int32>` |  |

`public Task<WorkflowFormEntity> CreateNewFormVersionAsync(SqlConnection connection, DateTime creationDate, string name, string defaultDefinition, int? version = null, string tenantId = null)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `connection` | `SqlConnection` |  |
| `creationDate` | `DateTime` |  |
| `name` | `String` |  |
| `defaultDefinition` | `String` |  |
| `version` | `Nullable<Int32>` |  |
| `tenantId` | `String` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<WorkflowFormEntity>` |  |

`public Task<WorkflowFormEntity> CreateNewFormIfNotExistsAsync(SqlConnection connection, DateTime creationDate, string name, string defaultDefinition, string tenantId = null)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `connection` | `SqlConnection` |  |
| `creationDate` | `DateTime` |  |
| `name` | `String` |  |
| `defaultDefinition` | `String` |  |
| `tenantId` | `String` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<WorkflowFormEntity>` |  |

`public Task<int> UpdateFormAsync(SqlConnection connection, string name, int version, long oldLock, long newLock, string definition, DateTime updatedDate, string tenantId = null)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `connection` | `SqlConnection` |  |
| `name` | `String` |  |
| `version` | `Int32` |  |
| `oldLock` | `Int64` |  |
| `newLock` | `Int64` |  |
| `definition` | `String` |  |
| `updatedDate` | `DateTime` |  |
| `tenantId` | `String` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task<Int32>` |  |

`public Task DeleteFormVersionAsync(SqlConnection connection, string name, int version, string tenantId = null)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `connection` | `SqlConnection` |  |
| `name` | `String` |  |
| `version` | `Int32` |  |
| `tenantId` | `String` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task` |  |

`public Task DeleteFormAsync(SqlConnection connection, string name, string tenantId = null)` 

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `connection` | `SqlConnection` |  |
| `name` | `String` |  |
| `tenantId` | `String` |  |

### Returns

| Type | Description |
| --- | --- |
| `Task` |  |

[Previous QueryDefinition](https://api.workflowengine.io/sql-server/OptimaJet.Workflow.MSSQL.Models/QueryDefinition/) [Next WorkflowRuntime](https://api.workflowengine.io/sql-server/OptimaJet.Workflow.MSSQL.Models/WorkflowRuntime/)