Class ObjectStoreStorageProvider

Component that stores Workflow instances, Workflows definitions and event queues in ObjectStore

Inheritance

System.Object

ObjectStoreStorageProvider

Implements

IStorageProvider

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.WorkflowFoundation.StorageProviders

Assembly: EPiServer.WorkflowFoundation.dll

Version: 8.11.0

Syntax

public class ObjectStoreStorageProvider : IStorageProvider

Constructors

ObjectStoreStorageProvider()

creates instance of provider

Declaration

public ObjectStoreStorageProvider()

Methods

AddDefinition(WorkflowDefinition)

Adds a Workflow definition to object store

Declaration

public virtual void AddDefinition(WorkflowDefinition definition)

Parameters

Type	Name	Description
WorkflowDefinition	definition	definition

AddInstance(WorkflowDefinitionInstance)

Adds a Workflow instance to object store

Declaration

public virtual void AddInstance(WorkflowDefinitionInstance instance)

Parameters

Type	Name	Description
WorkflowDefinitionInstance	instance	instance

GetWaitingInstances(String)

Gets the instances currently waiting for a specific event

Declaration

public virtual IList<Guid> GetWaitingInstances(string eventName)

Parameters

Type	Name	Description
System.String	eventName	Name of the event.

Returns

Type	Description
System.Collections.Generic.IList<System.Guid>	A list of all instances that waits for the specified event

Initialize()

Ensures that used types have schemas registered with object store

Declaration

public static void Initialize()

LoadDefinition(Guid)

loads a Workflow definition from object store

Declaration

public virtual WorkflowDefinition LoadDefinition(Guid definitionId)

Parameters

Type	Name	Description
System.Guid	definitionId	definition id

Returns

Type	Description
WorkflowDefinition	defintion

Exceptions

Type	Condition
WorkflowDefinitionException	definition not found in storage

LoadDefinitions()

Loads Workflow definitions from object store

Declaration

public virtual IList<WorkflowDefinition> LoadDefinitions()

Returns

Type	Description
System.Collections.Generic.IList<WorkflowDefinition>	definitions

LoadInstance(Guid)

Loads a Workflow instance from object store

Declaration

public virtual WorkflowDefinitionInstance LoadInstance(Guid instanceId)

Parameters

Type	Name	Description
System.Guid	instanceId	instance id

Returns

Type	Description
WorkflowDefinitionInstance	instance

Exceptions

Type	Condition
WorkflowInstanceException	instance not found in storage

LoadInstances()

Loads Workflow instances from object store

Declaration

public virtual IList<WorkflowDefinitionInstance> LoadInstances()

Returns

Type	Description
System.Collections.Generic.IList<WorkflowDefinitionInstance>	Workflow instances

RegisterWaitingInstance(Guid, String)

Registers that a instance is waiting for an event

Declaration

public virtual void RegisterWaitingInstance(Guid instanceId, string eventName)

Parameters

Type	Name	Description
System.Guid	instanceId	The instance id.
System.String	eventName	Name of the event.

RemoveDefinition(WorkflowDefinition)

Removes a definition from Workflow

Declaration

public virtual void RemoveDefinition(WorkflowDefinition definition)

Parameters

Type	Name	Description
WorkflowDefinition	definition	The definition to remove

RemoveInstance(Guid)

Removes a Workflow instance from object store

Declaration

public virtual void RemoveInstance(Guid instanceId)

Parameters

Type	Name	Description
System.Guid	instanceId	The id of the instance to remove

UnInitialize()

Declaration

public static void UnInitialize()

UnregisterInstance(Guid)

Unregisters the instance for all events.

Declaration

public virtual void UnregisterInstance(Guid instanceId)

Parameters

Type	Name	Description
System.Guid	instanceId	The instance id.

UnregisterWaitingInstance(Guid, String)

Unregister that a instance is waiting for an event

Declaration

public virtual void UnregisterWaitingInstance(Guid instanceId, string eventName)

Parameters

Type	Name	Description
System.Guid	instanceId	The instance id.
System.String	eventName	Name of the event.

UpdateDefinition(WorkflowDefinition)

Updates a defintion in object store

Declaration

public virtual void UpdateDefinition(WorkflowDefinition definition)

Parameters

Type	Name	Description
WorkflowDefinition	definition	definition

UpdateInstance(WorkflowDefinitionInstance)

Updates a Workflow instance in object store

Declaration

public virtual void UpdateInstance(WorkflowDefinitionInstance instance)

Parameters

Type	Name	Description
WorkflowDefinitionInstance	instance	instance

Implements

IStorageProvider