Workflow Class

Represents a process or workflow that executes a defined task or set of tasks. This class provides the basic logic to start, stop, pause and continue a workflow both synchronously and asynchronously.

Inheritance Hierarchy

SystemObject
Enkoni.FrameworkWorkflow

Namespace: Enkoni.Framework
Assembly: Enkoni.Framework (in Enkoni.Framework.dll) Version: 1.3.0.1

Syntax

C++

Copy

public abstract class Workflow : IWorkflow

Public MustInherit Class Workflow
	Implements IWorkflow

public ref class Workflow abstract : IWorkflow

[<AbstractClassAttribute>]
type Workflow =  
    class
        interface IWorkflow
    end

The Workflow type exposes the following members.

Constructors

	Name	Description
	Workflow	Initializes a new instance of the Workflow class. It sets the state to the initial value of Init.

Top

Properties

	Name	Description
	CanContinue	Gets a value indicating whether this workflow is in a state in which it can be continued. Only when the workflow supports pausing and the workflow is in the state Paused, it can be continued.
	CanPause	Gets a value indicating whether this workflow is in a state in which it can be paused. Only when the workflow supports pausing and the workflow is in the state Started or Continued, it can be paused.
	CanPauseAndContinue	Gets a value indicating whether the workflow is able to pause and continue its internal processes. By default, a Workflow cannot be paused or continued.
	CanStart	Gets a value indicating whether this workflow is in a state in which it can be started. Only when the workflow is in the state Init or Stopped, it can be started.
	CanStop	Gets a value indicating whether this workflow is in a state in which it can be stopped. Only when the workflow is in the state Started, Pausing or Continued, it can be stopped.
	State	Gets or sets the current WorkflowState of the workflow.

Top

Methods

	Name	Description
	BeginContinue	Begins to continue the workflow.
	BeginPause	Begins to pause the workflow.
	BeginStart	Begins to start the workflow.
	BeginStop	Begins to stop the workflow.
	Continue	Tries to continue the workflow. It blocks until the workflow is continued.
	EndContinue	Waits for the pending asynchronous continue to complete.
	EndPause	Waits for the pending asynchronous pause to complete.
	EndStart	Waits for the pending asynchronous start to complete.
	EndStop	Waits for the pending asynchronous stop to complete.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnContinue	Contains the actual continue logic. The default implementation is empty, subclasses will have to provide the implementation by overriding this method. Implementers of this method do not have to check the state of the workflow or change the state of the workflow as this is already done by the public Continue method.
	OnPause	Contains the actual pause logic. The default implementation is empty, subclasses will have to provide the implementation by overriding this method. Implementers of this method do not have to check the state of the workflow or change the state of the workflow as this is already done by the public Pause method.
	OnStart	Contains the actual start-up logic. The default implementation is empty, subclasses will have to provide the implementation by overriding this method. Implementers of this method do not have to check the state of the workflow or change the state of the workflow as this is already done by the public Start method.
	OnStop	Contains the actual stop logic. The default implementation is empty, subclasses will have to provide the implementation by overriding this method. Implementers of this method do not have to check the state of the workflow or change the state of the workflow as this is already done by the public Stop method.
	Pause	Tries to pause the workflow. It blocks until the workflow is paused.
	Start	Tries to start the workflow. It blocks until the workflow is started.
	Stop	Tries to stop the workflow. It blocks until the workflow is stopped.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

Enkoni.Framework Namespace