Workflow Engine .NET  2
Public Member Functions | List of all members
OptimaJet.Workflow.Core.Builder.IWorkflowBuilder Interface Reference

Interface of a workflow builder, which convert not parsed process scheme SchemeDefinition<T> to the object model of a scheme of a process ProcessDefinition More...

Inheritance diagram for OptimaJet.Workflow.Core.Builder.IWorkflowBuilder:
OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >

Public Member Functions

ProcessInstance CreateNewProcess (Guid processId, string schemeCode, IDictionary< string, object > parameters)
 Create new instance of the process. More...
 
ProcessInstance CreateNewSubprocess (Guid processId, ProcessInstance parentProcessInstance, TransitionDefinition startingTransition)
 
ProcessDefinition CreateNewProcessScheme (string schemeCode, IDictionary< string, object > parameters)
 Create new scheme for existing process More...
 
ProcessDefinition CreateNewSubprocessScheme (ProcessDefinition parentProcessScheme, TransitionDefinition startingTransition)
 
ProcessInstance GetProcessInstance (Guid processId)
 Returns existing process instance More...
 
ProcessDefinition GetProcessScheme (Guid schemeId)
 Returns process scheme by specific id, if scheme not exists creates it More...
 
void SetCache (IParsedProcessCache cache)
 Sets the cache to store parsed ProcessDefinition objects ProcessDefinition More...
 
void RemoveCache ()
 Removes the cache to store parsed ProcessDefinition objects ProcessDefinition More...
 
ProcessDefinition GetProcessScheme (string schemeCode)
 Returns process scheme by specific name, if scheme not exists creates it More...
 
ProcessDefinition GetProcessScheme (string schemeCode, IDictionary< string, object > parameters)
 Returns process scheme by specific name and parameters for creating the scheme of the process, if scheme not exists creates it More...
 
void SetSchemeIsObsolete (string schemeCode, Dictionary< string, object > parameters)
 Set IsObsolete sign to the scheme with specific name and parameters for creating the scheme of the process More...
 
void SetSchemeIsObsolete (string schemeCode)
 Set IsObsolete sign to the scheme with specific name More...
 
ProcessDefinition GetProcessSchemeForDesigner (string code)
 Returns existing process scheme directly from scheme persistence store More...
 
void SaveProcessScheme (string schemecode, ProcessDefinition pd)
 Saves process scheme to scheme persistence store More...
 
ProcessDefinition Parse (string scheme)
 Parses process scheme from the string More...
 
string Serialize (ProcessDefinition processDefinition)
 Serialize process scheme to the string More...
 

Detailed Description

Interface of a workflow builder, which convert not parsed process scheme SchemeDefinition<T> to the object model of a scheme of a process ProcessDefinition

Member Function Documentation

◆ CreateNewProcess()

ProcessInstance OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.CreateNewProcess ( Guid  processId,
string  schemeCode,
IDictionary< string, object >  parameters 
)

Create new instance of the process.

Parameters
processIdProcess id
schemeCodeCode of the scheme
parametersThe parameters for creating the scheme of the process
Returns
ProcessInstance object

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ CreateNewProcessScheme()

ProcessDefinition OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.CreateNewProcessScheme ( string  schemeCode,
IDictionary< string, object >  parameters 
)

Create new scheme for existing process

Parameters
schemeCodeCode of the scheme
parametersThe parameters for creating scheme of process
Returns
ProcessDefinition object

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ GetProcessInstance()

ProcessInstance OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.GetProcessInstance ( Guid  processId)

Returns existing process instance

Parameters
processIdProcess id
Returns
ProcessInstance object

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ GetProcessScheme() [1/3]

ProcessDefinition OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.GetProcessScheme ( Guid  schemeId)

Returns process scheme by specific id, if scheme not exists creates it

Parameters
schemeIdId of the scheme
Returns
ProcessDefinition object

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ GetProcessScheme() [2/3]

ProcessDefinition OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.GetProcessScheme ( string  schemeCode)

Returns process scheme by specific name, if scheme not exists creates it

Parameters
schemeCodeName of the scheme
Returns
ProcessDefinition object

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ GetProcessScheme() [3/3]

ProcessDefinition OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.GetProcessScheme ( string  schemeCode,
IDictionary< string, object >  parameters 
)

Returns process scheme by specific name and parameters for creating the scheme of the process, if scheme not exists creates it

Parameters
schemeCodeName of the scheme
parametersThe parameters for creating the scheme of the process
Returns
ProcessDefinition object

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ GetProcessSchemeForDesigner()

ProcessDefinition OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.GetProcessSchemeForDesigner ( string  code)

Returns existing process scheme directly from scheme persistence store

Parameters
codeName of the scheme
Returns
ProcessDefinition object

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ Parse()

ProcessDefinition OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.Parse ( string  scheme)

Parses process scheme from the string

Parameters
schemeString representation of not parsed scheme
Returns
ProcessDefinition object

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ RemoveCache()

void OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.RemoveCache ( )

Removes the cache to store parsed ProcessDefinition objects ProcessDefinition

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ SaveProcessScheme()

void OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.SaveProcessScheme ( string  schemecode,
ProcessDefinition  pd 
)

Saves process scheme to scheme persistence store

Parameters
schemecodeCode of the scheme
pdObject representation of the scheme

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ Serialize()

string OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.Serialize ( ProcessDefinition  processDefinition)

Serialize process scheme to the string

Parameters
processDefinitionSProcessDefinition object
Returns
String representation of not parsed scheme

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ SetCache()

void OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.SetCache ( IParsedProcessCache  cache)

Sets the cache to store parsed ProcessDefinition objects ProcessDefinition

Parameters
cacheInstance of cache object

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ SetSchemeIsObsolete() [1/2]

void OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.SetSchemeIsObsolete ( string  schemeCode,
Dictionary< string, object >  parameters 
)

Set IsObsolete sign to the scheme with specific name and parameters for creating the scheme of the process

Parameters
schemeCodeName of the scheme
parametersThe parameters for creating the scheme of the process

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.

◆ SetSchemeIsObsolete() [2/2]

void OptimaJet.Workflow.Core.Builder.IWorkflowBuilder.SetSchemeIsObsolete ( string  schemeCode)

Set IsObsolete sign to the scheme with specific name

Parameters
schemeCodeName of the scheme

Implemented in OptimaJet.Workflow.Core.Builder.WorkflowBuilder< TSchemeMedium >.