/Rock.ViewModels/Entities/WorkflowTypeBag.cs
C# | 270 lines | 37 code | 31 blank | 202 comment | 0 complexity | ae329782b8ebf0d5c175f770bbdd2f12 MD5 | raw file
1//------------------------------------------------------------------------------
2// <auto-generated>
3// This code was generated by the Rock.CodeGeneration project
4// Changes to this file will be lost when the code is regenerated.
5// </auto-generated>
6//------------------------------------------------------------------------------
7// <copyright>
8// Copyright by the Spark Development Network
9//
10// Licensed under the Rock Community License (the "License");
11// you may not use this file except in compliance with the License.
12// You may obtain a copy of the License at
13//
14// http://www.rockrms.com/license
15//
16// Unless required by applicable law or agreed to in writing, software
17// distributed under the License is distributed on an "AS IS" BASIS,
18// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19// See the License for the specific language governing permissions and
20// limitations under the License.
21// </copyright>
22//
23
24using System;
25using System.Linq;
26
27using Rock.ViewModels.Utility;
28
29namespace Rock.ViewModels.Entities
30{
31 /// <summary>
32 /// WorkflowType View Model
33 /// </summary>
34 public partial class WorkflowTypeBag : EntityBagBase
35 {
36 /// <summary>
37 /// Gets or sets the CategoryId of the Rock.Model.Category that this WorkflowType belongs to.
38 /// </summary>
39 /// <value>
40 /// A System.Int32 representing the CategoryId of the Rock.Model.Category that the WorkflowType belongs to.
41 /// If the WorkflowType does not belong to a category, this value will be null.
42 /// </value>
43 public int? CategoryId { get; set; }
44
45 /// <summary>
46 /// Gets or sets the completed workflow retention period in days.
47 /// </summary>
48 /// <value>
49 /// The completed workflow retention period in days.
50 /// </value>
51 public int? CompletedWorkflowRetentionPeriod { get; set; }
52
53 /// <summary>
54 /// Gets or sets a user defined description or summary about the WorkflowType.
55 /// </summary>
56 /// <value>
57 /// A System.String representing a description/summary of the WorkflowType.
58 /// </value>
59 public string Description { get; set; }
60
61 /// <summary>
62 /// Gets or sets the form builder settings json.
63 /// </summary>
64 /// <value>
65 /// The form builder settings json.
66 /// </value>
67 public string FormBuilderSettingsJson { get; set; }
68
69 /// <summary>
70 /// Gets or sets the form builder template identifier.
71 /// </summary>
72 /// <value>
73 /// The form builder template identifier.
74 /// </value>
75 public int? FormBuilderTemplateId { get; set; }
76
77 /// <summary>
78 /// Gets or sets the form end date and time.
79 /// </summary>
80 /// <value>
81 /// The form end date and time.
82 /// </value>
83 public DateTime? FormEndDateTime { get; set; }
84
85 /// <summary>
86 /// Gets or sets the form start date and time.
87 /// </summary>
88 /// <value>
89 /// The form start date and time.
90 /// </value>
91 public DateTime? FormStartDateTime { get; set; }
92
93 /// <summary>
94 /// Gets or sets the name of the icon CSS class. This property is only used for CSS based icons.
95 /// </summary>
96 /// <value>
97 /// A System.String representing the name of the icon CSS class. This property will be null if a file based icon is being used.
98 /// </value>
99 public string IconCssClass { get; set; }
100
101 /// <summary>
102 /// Gets or sets a flag indicating if this WorkflowType is active.
103 /// </summary>
104 /// <value>
105 /// A System.Boolean that is true if the WorkflowType is active; otherwise false.
106 /// </value>
107 public bool? IsActive { get; set; }
108
109 /// <summary>
110 /// Gets or sets a value indicating whether [is form builder].
111 /// </summary>
112 /// <value>
113 /// true if [is form builder]; otherwise, false.
114 /// </value>
115 public bool IsFormBuilder { get; set; }
116
117 /// <summary>
118 /// Gets or sets a value indicating whether [is login required].
119 /// </summary>
120 /// <value>
121 /// true if [is login required]; otherwise, false.
122 /// </value>
123 public bool IsLoginRequired { get; set; }
124
125 /// <summary>
126 /// Gets or sets a value indicating whether Rock.Model.Workflow instances of this WorkflowType are persisted.
127 /// </summary>
128 /// <value>
129 /// A System.Boolean value that is true if Rock.Model.Workflow instances of this WorkflowType are persisted; otherwise false.
130 /// </value>
131 public bool IsPersisted { get; set; }
132
133 /// <summary>
134 /// Gets or sets a flag indicating if this WorkflowType is part of the Rock core system/framework.
135 /// </summary>
136 /// <value>
137 /// A System.Boolean that is true if the WorkflowType is part of the Rock core system/framework; otherwise false.
138 /// </value>
139 public bool IsSystem { get; set; }
140
141 /// <summary>
142 /// Gets or sets the logging level.
143 /// Gets or sets the Rock.Model.WorkflowLoggingLevel indicating the level of detail that should be logged when instances of this WorkflowType are executed.
144 /// </summary>
145 /// <value>
146 /// A Rock.Model.WorkflowLoggingLevel value indicating the level of detail that should be logged when instances of this WorkflowType are executed.
147 /// When WorkflowLoggingLevel.None no details of the Workflow instance's execution will be logged.
148 /// When WorkflowLoggingLevel.Workflow only workflow events will be logged (i.e. begin and end).
149 /// When WorkflowLoggingLevel.Activity workflow and activity events will be logged.
150 /// When WorkflowLoggingLevel.Action workflow, activity and action events will be logged.
151 /// </value>
152 public int LoggingLevel { get; set; }
153
154 /// <summary>
155 /// Gets or sets the log retention period in days.
156 /// </summary>
157 /// <value>
158 /// The log retention period in days.
159 /// </value>
160 public int? LogRetentionPeriod { get; set; }
161
162 /// <summary>
163 /// Gets or sets the number of days since the creation date after which a workflow would be automatically marked completed.
164 /// </summary>
165 /// <value>
166 /// The number of days since the creation date after which a workflow would be automatically marked completed.
167 /// </value>
168 public int? MaxWorkflowAgeDays { get; set; }
169
170 /// <summary>
171 /// Gets or sets the friendly Name of the WorkflowType. This property is required.
172 /// </summary>
173 /// <value>
174 /// A System.String representing the friendly Name of the WorkflowType.
175 /// </value>
176 public string Name { get; set; }
177
178 /// <summary>
179 /// Gets or sets the text to be displayed when a workflow of this type workflow is active, but does not have an active form. This field supports Lava.
180 /// </summary>
181 /// <value>
182 /// The summary view text.
183 /// </value>
184 public string NoActionMessage { get; set; }
185
186 /// <summary>
187 /// Gets or sets the display order of the WorkFlowType, the lower the number the higher up that the WorkflowType will display in the workflow list. This
188 /// property is required.
189 /// </summary>
190 /// <value>
191 /// A System.Int32 representing the display order of the WorkflowType.
192 /// </value>
193 public int Order { get; set; }
194
195 /// <summary>
196 /// Gets or sets the minimum length of time, in seconds, before a persisted Rock.Model.Workflow instance that implements this
197 /// WorkflowType can be re-executed.
198 /// </summary>
199 /// <value>
200 /// A System.Int32 representing the minimum length of time, in seconds, that must pass before the same persisted Rock.Model.Workflow instance
201 /// that implements this WorkflowType can be re-executed.
202 /// </value>
203 public int? ProcessingIntervalSeconds { get; set; }
204
205 /// <summary>
206 /// Gets or sets the summary view text to be displayed when a workflow of this type has no form or has been completed. This field supports Lava.
207 /// </summary>
208 /// <value>
209 /// The summary view text.
210 /// </value>
211 public string SummaryViewText { get; set; }
212
213 /// <summary>
214 /// Gets or sets the date time when the workflow of this type will no longer be processed.
215 /// </summary>
216 /// <value>
217 /// The workflow expire date time.
218 /// </value>
219 public DateTime? WorkflowExpireDateTime { get; set; }
220
221 /// <summary>
222 /// Gets or sets the workflow identifier prefix.
223 /// </summary>
224 /// <value>
225 /// The workflow identifier prefix.
226 /// </value>
227 public string WorkflowIdPrefix { get; set; }
228
229 /// <summary>
230 /// Gets or sets the work term for the WorkflowType. This is the action that is being performed by this WorkflowType. This property is required.
231 /// </summary>
232 /// <value>
233 /// A System.String representing the WorkItem that is being performed by this WorkflowType
234 /// </value>
235 public string WorkTerm { get; set; }
236
237 /// <summary>
238 /// Gets or sets the created date time.
239 /// </summary>
240 /// <value>
241 /// The created date time.
242 /// </value>
243 public DateTime? CreatedDateTime { get; set; }
244
245 /// <summary>
246 /// Gets or sets the modified date time.
247 /// </summary>
248 /// <value>
249 /// The modified date time.
250 /// </value>
251 public DateTime? ModifiedDateTime { get; set; }
252
253 /// <summary>
254 /// Gets or sets the created by person alias identifier.
255 /// </summary>
256 /// <value>
257 /// The created by person alias identifier.
258 /// </value>
259 public int? CreatedByPersonAliasId { get; set; }
260
261 /// <summary>
262 /// Gets or sets the modified by person alias identifier.
263 /// </summary>
264 /// <value>
265 /// The modified by person alias identifier.
266 /// </value>
267 public int? ModifiedByPersonAliasId { get; set; }
268
269 }
270}