# Interface IInlineActivityBuilder

OptimaJet.Workflow.Core.Model.Builder.IInlineActivityBuilder

Defines fluent operations for configuring an inline [ActivityDefinition](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActivityDefinition/) that references a reusable process scheme.

Namespace: [OptimaJet.Workflow.Core.Model.Builder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/)

```csharp
public interface IInlineActivityBuilder : IBaseActivityBuilder, IProcessDefinitionBuilder
```

## Type Hierarchy

-   IInlineActivityBuilder Current type
    -   Base interfaces
        -   [IBaseActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IBaseActivityBuilder/)
            -   [IProcessDefinitionBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IProcessDefinitionBuilder/)

## Methods

`IInlineActivityBuilder Scheme(string schemeCode)` 

Sets [ActivityDefinition.SchemeCode](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActivityDefinition/) for the inline activity.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `schemeCode` | `String` | The code of the process scheme to reference. |

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

`IInlineActivityBuilder SetInputParameters(IEnumerable<ParameterMapping> parameterMappings)` 

Replaces the input [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) instances that pass values from the parent scheme into the inlined scheme.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `parameterMappings` | `IEnumerable<ParameterMapping>` | The input [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) instances to apply when execution enters the inlined scheme. |

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

### Exceptions

| Type | Description |
| --- | --- |
| `ArgumentNullException` | `parameterMappings` is [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null). |
| `InvalidOperationException` | A [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) has [ParameterMapping.Purpose](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) set to [ParameterPurpose.System](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ParameterPurpose/). |

`IInlineActivityBuilder SetInputParameters(params ParameterMapping[] parameterMappings)` 

Replaces the input [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) instances that pass values from the parent scheme into the inlined scheme.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `parameterMappings` | `ParameterMapping[]` | The input [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) instances to apply when execution enters the inlined scheme. |

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

### Exceptions

| Type | Description |
| --- | --- |
| `ArgumentNullException` | `parameterMappings` is [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null). |
| `InvalidOperationException` | A [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) has [ParameterMapping.Purpose](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) set to [ParameterPurpose.System](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ParameterPurpose/). |

`IInlineActivityBuilder SetOutputParameters(IEnumerable<ParameterMapping> parameterMappings)` 

Replaces the output [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) instances that pass values from the inlined scheme back to the parent scheme.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `parameterMappings` | `IEnumerable<ParameterMapping>` | The output [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) instances to apply when execution leaves the inlined scheme. |

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

### Exceptions

| Type | Description |
| --- | --- |
| `ArgumentNullException` | `parameterMappings` is [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null). |
| `InvalidOperationException` | A [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) has [ParameterMapping.Purpose](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) set to [ParameterPurpose.System](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ParameterPurpose/). |

`IInlineActivityBuilder SetOutputParameters(params ParameterMapping[] parameterMappings)` 

Replaces the output [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) instances that pass values from the inlined scheme back to the parent scheme.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `parameterMappings` | `ParameterMapping[]` | The output [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) instances to apply when execution leaves the inlined scheme. |

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

### Exceptions

| Type | Description |
| --- | --- |
| `ArgumentNullException` | `parameterMappings` is [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null). |
| `InvalidOperationException` | A [ParameterMapping](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) has [ParameterMapping.Purpose](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Execution/ParameterMapping/) set to [ParameterPurpose.System](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ParameterPurpose/). |

`IInlineActivityBuilder CreateCommentary(string comment)` 

Sets [ActivityDefinition.UserComment](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActivityDefinition/) for the inline activity, replacing any existing comment.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `comment` | `String` | The comment text to store. |

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

`IInlineActivityBuilder AppendCommentary(string comment)` 

Appends `comment` to [ActivityDefinition.UserComment](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActivityDefinition/), inserting a line feed first when the existing comment is not empty.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `comment` | `String` | The comment text to append. |

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

`IInlineActivityBuilder DeleteCommentary()` 

Clears [ActivityDefinition.UserComment](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActivityDefinition/) for the inline activity.

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

`IInlineActivityBuilder Ref(out ActivityDefinition activityDefinition)` 

Assigns the inline [ActivityDefinition](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActivityDefinition/) being configured to `activityDefinition`.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `activityDefinition` | `ActivityDefinition` | Receives the inline [ActivityDefinition](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ActivityDefinition/) being configured. |

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

`IInlineActivityBuilder SetX(int? x)` 

Sets [DesignerSettings.X](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/DesignerSettings/) for the inline activity.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `x` | `Nullable<Int32>` | The horizontal coordinate, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) to clear [DesignerSettings.X](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/DesignerSettings/). |

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

`IInlineActivityBuilder SetY(int? y)` 

Sets [DesignerSettings.Y](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/DesignerSettings/) for the inline activity.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `y` | `Nullable<Int32>` | The vertical coordinate, or [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null) to clear [DesignerSettings.Y](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/DesignerSettings/). |

### Returns

| Type | Description |
| --- | --- |
| `IInlineActivityBuilder` | The current [IInlineActivityBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IInlineActivityBuilder/) instance. |

[Previous IIdleTimeoutBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IIdleTimeoutBuilder/) [Next IParameterBuilder](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model.Builder/IParameterBuilder/)