Assembly: OptimaJet.Workflow.Core

Interface IInlineActivityBuilder

OptimaJet.Workflow.Core.Model.Builder.IInlineActivityBuilder

Defines fluent operations for configuring an inline ActivityDefinition that references a reusable process scheme.

Namespace: OptimaJet.Workflow.Core.Model.Builder

public interface IInlineActivityBuilder : IBaseActivityBuilder, IProcessDefinitionBuilder

Type Hierarchy

Methods

IInlineActivityBuilder Scheme(string schemeCode) #
Sets ActivityDefinition.SchemeCode 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 instance.
IInlineActivityBuilder SetInputParameters(IEnumerable<ParameterMapping> parameterMappings) #
Replaces the input ParameterMapping instances that pass values from the parent scheme into the inlined scheme.

Parameters

Name
Type
Description
parameterMappings
IEnumerable<ParameterMapping>
The input ParameterMapping instances to apply when execution enters the inlined scheme.

Returns

Type
Description
IInlineActivityBuilder
The current IInlineActivityBuilder instance.

Exceptions

Type
Description
ArgumentNullException
parameterMappings is null.
InvalidOperationException
A ParameterMapping has ParameterMapping.Purpose set to ParameterPurpose.System.
IInlineActivityBuilder SetInputParameters(params ParameterMapping[] parameterMappings) #
Replaces the input ParameterMapping instances that pass values from the parent scheme into the inlined scheme.

Parameters

Name
Type
Description
parameterMappings
ParameterMapping[]
The input ParameterMapping instances to apply when execution enters the inlined scheme.

Returns

Type
Description
IInlineActivityBuilder
The current IInlineActivityBuilder instance.

Exceptions

Type
Description
ArgumentNullException
parameterMappings is null.
InvalidOperationException
A ParameterMapping has ParameterMapping.Purpose set to ParameterPurpose.System.
IInlineActivityBuilder SetOutputParameters(IEnumerable<ParameterMapping> parameterMappings) #
Replaces the output ParameterMapping instances that pass values from the inlined scheme back to the parent scheme.

Parameters

Name
Type
Description
parameterMappings
IEnumerable<ParameterMapping>
The output ParameterMapping instances to apply when execution leaves the inlined scheme.

Returns

Type
Description
IInlineActivityBuilder
The current IInlineActivityBuilder instance.

Exceptions

Type
Description
ArgumentNullException
parameterMappings is null.
InvalidOperationException
A ParameterMapping has ParameterMapping.Purpose set to ParameterPurpose.System.
IInlineActivityBuilder SetOutputParameters(params ParameterMapping[] parameterMappings) #
Replaces the output ParameterMapping instances that pass values from the inlined scheme back to the parent scheme.

Parameters

Name
Type
Description
parameterMappings
ParameterMapping[]
The output ParameterMapping instances to apply when execution leaves the inlined scheme.

Returns

Type
Description
IInlineActivityBuilder
The current IInlineActivityBuilder instance.

Exceptions

Type
Description
ArgumentNullException
parameterMappings is null.
InvalidOperationException
A ParameterMapping has ParameterMapping.Purpose set to ParameterPurpose.System.
IInlineActivityBuilder CreateCommentary(string comment) #
Sets ActivityDefinition.UserComment 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 instance.
IInlineActivityBuilder AppendCommentary(string comment) #
Appends comment to ActivityDefinition.UserComment, 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 instance.
IInlineActivityBuilder DeleteCommentary() #
Clears ActivityDefinition.UserComment for the inline activity.

Returns

Type
Description
IInlineActivityBuilder
The current IInlineActivityBuilder instance.
IInlineActivityBuilder Ref(out ActivityDefinition activityDefinition) #
Assigns the inline ActivityDefinition being configured to activityDefinition.

Parameters

Name
Type
Description
activityDefinition
ActivityDefinition
Receives the inline ActivityDefinition being configured.

Returns

Type
Description
IInlineActivityBuilder
The current IInlineActivityBuilder instance.
IInlineActivityBuilder SetX(int? x) #
Sets DesignerSettings.X for the inline activity.

Parameters

Name
Type
Description
x
Nullable<Int32>
The horizontal coordinate, or null to clear DesignerSettings.X.

Returns

Type
Description
IInlineActivityBuilder
The current IInlineActivityBuilder instance.
IInlineActivityBuilder SetY(int? y) #
Sets DesignerSettings.Y for the inline activity.

Parameters

Name
Type
Description
y
Nullable<Int32>
The vertical coordinate, or null to clear DesignerSettings.Y.

Returns

Type
Description
IInlineActivityBuilder
The current IInlineActivityBuilder instance.