forked from optimajet/WorkflowEngine.NET
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathIWorkflowBuilder.cs
More file actions
124 lines (105 loc) · 5.35 KB
/
Copy pathIWorkflowBuilder.cs
File metadata and controls
124 lines (105 loc) · 5.35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
using System;
using System.Collections.Generic;
using OptimaJet.Workflow.Core.Cache;
using OptimaJet.Workflow.Core.Model;
namespace OptimaJet.Workflow.Core.Builder
{
/// <summary>
/// Interface of a workflow builder, which convert not parsed process scheme <see cref="SchemeDefinition{T}"/> to the object model of a scheme of a process <see cref="ProcessDefinition"/>
/// </summary>
public interface IWorkflowBuilder
{
/// <summary>
/// Create new instance of the process.
/// </summary>
/// <param name="processId">Process id</param>
/// <param name="schemeCode">Code of the scheme</param>
/// <param name="parameters">The parameters for creating the scheme of the process</param>
/// <returns>ProcessInstance object</returns>
ProcessInstance CreateNewProcess(Guid processId,
string schemeCode,
IDictionary<string, object> parameters);
ProcessInstance CreateNewSubprocess(Guid processId,
ProcessInstance parentProcessInstance,
TransitionDefinition startingTransition
);
/// <summary>
/// Create new scheme for existing process
/// </summary>
/// <param name="schemeCode">Code of the scheme</param>
/// <param name="parameters">The parameters for creating scheme of process</param>
/// <returns>ProcessDefinition object</returns>
ProcessDefinition CreateNewProcessScheme(string schemeCode, IDictionary<string, object> parameters);
ProcessDefinition CreateNewSubprocessScheme(ProcessDefinition parentProcessScheme,
TransitionDefinition startingTransition);
/// <summary>
/// Returns existing process instance
/// </summary>
/// <param name="processId">Process id</param>
/// <returns>ProcessInstance object</returns>
ProcessInstance GetProcessInstance(Guid processId);
/// <summary>
/// Returns process scheme by specific id, if scheme not exists creates it
/// </summary>
/// <param name="schemeId">Id of the scheme</param>
/// <returns>ProcessDefinition object</returns>
ProcessDefinition GetProcessScheme(Guid schemeId);
/// <summary>
/// Sets the cache to store parsed ProcessDefinition objects <see cref="ProcessDefinition"/>
/// </summary>
/// <param name="cache">Instance of cache object</param>
void SetCache(IParsedProcessCache cache);
/// <summary>
/// Removes the cache to store parsed ProcessDefinition objects <see cref="ProcessDefinition"/>
/// </summary>
void RemoveCache();
/// <summary>
/// Returns process scheme by specific name, if scheme not exists creates it
/// </summary>
/// <param name="schemeCode">Name of the scheme</param>
/// <returns>ProcessDefinition object</returns>
ProcessDefinition GetProcessScheme(string schemeCode);
/// <summary>
/// Returns process scheme by specific name and parameters for creating the scheme of the process, if scheme not exists creates it
/// </summary>
/// <param name="schemeCode">Name of the scheme</param>
/// <param name="parameters">The parameters for creating the scheme of the process</param>
/// <returns>ProcessDefinition object</returns>
ProcessDefinition GetProcessScheme(string schemeCode, IDictionary<string, object> parameters);
/// <summary>
/// Set IsObsolete sign to the scheme with specific name and parameters for creating the scheme of the process
/// </summary>
/// <param name="schemeCode">Name of the scheme</param>
/// <param name="parameters">The parameters for creating the scheme of the process</param>
void SetSchemeIsObsolete(string schemeCode, Dictionary<string, object> parameters);
/// <summary>
/// Set IsObsolete sign to the scheme with specific name
/// </summary>
/// <param name="schemeCode">Name of the scheme</param>
void SetSchemeIsObsolete(string schemeCode);
/// <summary>
/// Returns existing process scheme directly from scheme persistence store
/// </summary>
/// <param name="code">Name of the scheme</param>
/// <returns>ProcessDefinition object</returns>
ProcessDefinition GetProcessSchemeForDesigner(string code);
/// <summary>
/// Saves process scheme to scheme persistence store
/// </summary>
/// <param name="schemecode">Code of the scheme</param>
/// <param name="pd">Object representation of the scheme</param>
void SaveProcessScheme(string schemecode, ProcessDefinition pd);
/// <summary>
/// Parses process scheme from the string
/// </summary>
/// <param name="scheme">String representation of not parsed scheme</param>
/// <returns>ProcessDefinition object</returns>
ProcessDefinition Parse(string scheme);
/// <summary>
/// Serialize process scheme to the string
/// </summary>
/// <param name="processDefinition">SProcessDefinition object</param>
/// <returns>String representation of not parsed scheme</returns>
string Serialize(ProcessDefinition processDefinition);
}
}