Assembly: OptimaJet.Workflow.Core

Interface ITransitionCommandBuilder

OptimaJet.Workflow.Core.Model.Builder.ITransitionCommandBuilder

Represents a builder for configuring the actor-based authorization restrictions in TransitionDefinition.Restrictions for a command-triggered transition.

Namespace: OptimaJet.Workflow.Core.Model.Builder

public interface ITransitionCommandBuilder : ITransitionBuilder, IProcessDefinitionBuilder

Type Hierarchy

Methods

ITransitionCommandBuilder CreateRestriction(ActorDefinition actorDefinition, RestrictionType restrictionType) #
Adds an actor-based authorization restriction to TransitionDefinition.Restrictions for the current command-triggered transition.

Parameters

Name
Type
Description
actorDefinition
ActorDefinition
The ActorDefinition whose ActorDefinition.Rule is evaluated for the RestrictionDefinition.
restrictionType
RestrictionType
The RestrictionType that determines how the result of ActorDefinition.Rule affects authorization.

Returns

Type
Description
ITransitionCommandBuilder
The current ITransitionCommandBuilder instance.

Exceptions

Type
Description
TransitionRestrictionAlreadyExistsException
A RestrictionDefinition associated with actorDefinition already exists on the current transition.
ITransitionCommandBuilder CreateOrUpdateRestriction(ActorDefinition actorDefinition, RestrictionType restrictionType) #
Adds an actor-based authorization restriction to TransitionDefinition.Restrictions for the current command-triggered transition, or changes the RestrictionDefinition.Type of the restriction already associated with actorDefinition.

Parameters

Name
Type
Description
actorDefinition
ActorDefinition
The ActorDefinition whose ActorDefinition.Rule is evaluated for the RestrictionDefinition.
restrictionType
RestrictionType
The RestrictionType to assign to the new or existing RestrictionDefinition.

Returns

Type
Description
ITransitionCommandBuilder
The current ITransitionCommandBuilder instance.
ITransitionCommandBuilder UpdateRestriction(ActorDefinition actorDefinition, RestrictionType restrictionType) #
Changes the RestrictionDefinition.Type of the restriction associated with actorDefinition.

Parameters

Name
Type
Description
actorDefinition
ActorDefinition
The ActorDefinition associated with the RestrictionDefinition to update.
restrictionType
RestrictionType
The new RestrictionType.

Returns

Type
Description
ITransitionCommandBuilder
The current ITransitionCommandBuilder instance.

Exceptions

Type
Description
TransitionRestrictionNotFoundException
No RestrictionDefinition associated with actorDefinition exists on the current transition.
ITransitionCommandBuilder DeleteRestriction(ActorDefinition actorDefinition) #
Removes any actor-based authorization RestrictionDefinition associated with actorDefinition from the current command-triggered transition.

Parameters

Name
Type
Description
actorDefinition
ActorDefinition
The ActorDefinition associated with the RestrictionDefinition to remove.

Returns

Type
Description
ITransitionCommandBuilder
The current ITransitionCommandBuilder instance.
ITransitionCommandBuilder ConcatAllowByAnd() #
Sets TransitionDefinition.AllowConcatenationType to ConcatenationType.And for the current transition; when RestrictionType.Allow restrictions are present, each must match the workflow participant identity being authorized.

Returns

Type
Description
ITransitionCommandBuilder
The current ITransitionCommandBuilder instance.
ITransitionCommandBuilder ConcatAllowByOr() #
Sets TransitionDefinition.AllowConcatenationType to ConcatenationType.Or for the current transition; when RestrictionType.Allow restrictions are present, at least one must match the workflow participant identity being authorized.

Returns

Type
Description
ITransitionCommandBuilder
The current ITransitionCommandBuilder instance.
ITransitionCommandBuilder ConcatRestrictByAnd() #
Sets TransitionDefinition.RestrictConcatenationType to ConcatenationType.And for the current transition; when RestrictionType.Restrict restrictions are present, they deny a workflow participant identity only if each restriction matches.

Returns

Type
Description
ITransitionCommandBuilder
The current ITransitionCommandBuilder instance.
ITransitionCommandBuilder ConcatRestrictByOr() #
Sets TransitionDefinition.RestrictConcatenationType to ConcatenationType.Or for the current transition; when RestrictionType.Restrict restrictions are present, they deny a workflow participant identity if at least one restriction matches.

Returns

Type
Description
ITransitionCommandBuilder
The current ITransitionCommandBuilder instance.