Craig's Utility Library  4.0 Beta
Utilities.Workflow.Manager.Workflow< T > Class Template Reference

Workflow holder More...

Inheritance diagram for Utilities.Workflow.Manager.Workflow< T >:
Utilities.Workflow.Manager.Interfaces.IWorkflow< T >

Public Member Functions

 Workflow (string Name)
 Initializes a new instance of the Workflow<T> class. More...
 
IWorkflow< T > And< OperationType > (params IConstraint< T >[] Constraints)
 Causes multiple commands to be executed concurrently More...
 
IWorkflow< T > And (IOperation< T > Operation, params IConstraint< T >[] Constraints)
 Causes multiple commands to be executed concurrently More...
 
IWorkflow< T > And (Func< T, T > Operation, params IConstraint< T >[] Constraints)
 Causes multiple commands to be executed concurrently More...
 
IWorkflow< T > And (IWorkflow< T > Workflow, params IConstraint< T >[] Constraints)
 Causes multiple commands to be executed concurrently More...
 
IWorkflow< T > Do< OperationType > (params IConstraint< T >[] Constraints)
 Adds an instance of the specified operation type to the workflow More...
 
IWorkflow< T > Do (IOperation< T > Operation, params IConstraint< T >[] Constraints)
 Adds the specified operation to the workflow More...
 
IWorkflow< T > Do (Func< T, T > Operation, params IConstraint< T >[] Constraints)
 Adds the specified operation to the workflow More...
 
IWorkflow< T > Do (IWorkflow< T > Workflow, params IConstraint< T >[] Constraints)
 Appends the workflow specified to this workflow as an operation More...
 
IWorkflow< T > On< ExceptionType > (Action< T > Operation)
 Called when an exception of the specified type is thrown in the workflow More...
 
IWorkflow< T > Repeat (int Times=1)
 Repeats the last operation the specified number of times. More...
 
IWorkflow< T > Retry (int Times=1)
 Retries the last operation the specified number of times if it fails. More...
 
Start (T Data)
 Starts the workflow with the specified data More...
 

Properties

Type DataType [get]
 Gets the type of the data expected More...
 
string Name [get]
 Gets the name. More...
 
ICollection< IWorkflowNode< T > > Nodes [get]
 Gets the nodes. More...
 

Detailed Description

Workflow holder

Template Parameters
TData type

Definition at line 36 of file Workflow.cs.

Constructor & Destructor Documentation

Initializes a new instance of the Workflow<T> class.

Parameters
NameThe name.

Definition at line 42 of file Workflow.cs.

Member Function Documentation

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.And ( IOperation< T >  Operation,
params IConstraint< T >[]  Constraints 
)

Causes multiple commands to be executed concurrently

Parameters
OperationThe operation to add.
ConstraintsDetermines if the operation should be run or if it should be skipped
Returns
The workflow object

Definition at line 101 of file Workflow.cs.

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.And ( Func< T, T >  Operation,
params IConstraint< T >[]  Constraints 
)

Causes multiple commands to be executed concurrently

Parameters
OperationThe operation to add.
ConstraintsDetermines if the operation should be run or if it should be skipped
Returns
The workflow object

Definition at line 118 of file Workflow.cs.

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.And ( IWorkflow< T >  Workflow,
params IConstraint< T >[]  Constraints 
)

Causes multiple commands to be executed concurrently

Parameters
WorkflowThe workflow to append
ConstraintsDetermines if the operation should be run or if it should be skipped
Returns
The resulting workflow object

Definition at line 131 of file Workflow.cs.

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.And< OperationType > ( params IConstraint< T >[]  Constraints)

Causes multiple commands to be executed concurrently

Template Parameters
OperationTypeThe type of the operation.
Parameters
ConstraintsDetermines if the operation should be run or if it should be skipped
Returns
The workflow object
Type Constraints
OperationType :IOperation<T> 
OperationType :new() 

Definition at line 87 of file Workflow.cs.

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.Do ( IOperation< T >  Operation,
params IConstraint< T >[]  Constraints 
)

Adds the specified operation to the workflow

Parameters
OperationThe operation to add.
ConstraintsDetermines if the operation should be run or if it should be skipped
Returns
The workflow object

Definition at line 162 of file Workflow.cs.

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.Do ( Func< T, T >  Operation,
params IConstraint< T >[]  Constraints 
)

Adds the specified operation to the workflow

Parameters
OperationThe operation to add.
ConstraintsDetermines if the operation should be run or if it should be skipped
Returns
The workflow object

Definition at line 177 of file Workflow.cs.

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.Do ( IWorkflow< T >  Workflow,
params IConstraint< T >[]  Constraints 
)

Appends the workflow specified to this workflow as an operation

Parameters
WorkflowThe workflow to append
ConstraintsDetermines if the operation should be run or if it should be skipped
Returns
The resulting workflow object

Definition at line 190 of file Workflow.cs.

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.Do< OperationType > ( params IConstraint< T >[]  Constraints)

Adds an instance of the specified operation type to the workflow

Template Parameters
OperationTypeThe type of the operation.
Parameters
ConstraintsDetermines if the operation should be run or if it should be skipped
Returns
The workflow object
Type Constraints
OperationType :IOperation<T> 
OperationType :new() 

Definition at line 148 of file Workflow.cs.

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.On< ExceptionType > ( Action< T >  Operation)

Called when an exception of the specified type is thrown in the workflow

Template Parameters
ExceptionTypeThe exception type.
Parameters
OperationThe operation to run.
Returns
The resulting workflow object
Type Constraints
ExceptionType :Exception 

Definition at line 203 of file Workflow.cs.

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.Repeat ( int  Times = 1)

Repeats the last operation the specified number of times.

Parameters
TimesThe number of times to repeat
Returns
The workflow object

Definition at line 215 of file Workflow.cs.

IWorkflow<T> Utilities.Workflow.Manager.Workflow< T >.Retry ( int  Times = 1)

Retries the last operation the specified number of times if it fails.

Parameters
TimesThe number of times to retry.
Returns
The workflow object

Definition at line 226 of file Workflow.cs.

T Utilities.Workflow.Manager.Workflow< T >.Start ( Data)

Starts the workflow with the specified data

Parameters
DataThe data to pass in to the workflow
Returns
The result from the workflow

Definition at line 237 of file Workflow.cs.

Property Documentation

Type Utilities.Workflow.Manager.Workflow< T >.DataType
get

Gets the type of the data expected

The type of the data expected

Definition at line 53 of file Workflow.cs.

Gets the name.

The name.

Definition at line 59 of file Workflow.cs.

ICollection<IWorkflowNode<T> > Utilities.Workflow.Manager.Workflow< T >.Nodes
get

Gets the nodes.

The nodes.

Definition at line 65 of file Workflow.cs.


The documentation for this class was generated from the following file: