bbvcommon 6.268.0.20100803

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,659 @@
1
+ <?xml version="1.0"?>
2
+ <doc>
3
+ <assembly>
4
+ <name>bbv.Common.RuleEngine</name>
5
+ </assembly>
6
+ <members>
7
+ <member name="T:bbv.Common.RuleEngine.IAggregator`2">
8
+ <summary>
9
+ An aggregator is used to combine the results of all rules taking part in the evaluation into a single result.
10
+ </summary>
11
+ <typeparam name="TRule">The type of the rule.</typeparam>
12
+ <typeparam name="TAggregationResult">The type of the aggregation result.</typeparam>
13
+ </member>
14
+ <member name="M:bbv.Common.RuleEngine.IAggregator`2.Aggregate(bbv.Common.RuleEngine.IRuleSet{`0},System.String@)">
15
+ <summary>
16
+ Aggregates the specified rule set.
17
+ </summary>
18
+ <param name="ruleSet">The rule set.</param>
19
+ <param name="logInfo">The log info. The aggregator should provide information about the results of the different rules and how they
20
+ influenced the overall result. This info is written to the log by the rule engine.</param>
21
+ <returns>The aggregated result of all rules takingpart in the evaluation.</returns>
22
+ </member>
23
+ <member name="T:bbv.Common.RuleEngine.IFactory`1">
24
+ <summary>
25
+ Factory used to create instances of classes used in rule engine.
26
+ </summary>
27
+ <typeparam name="TRule">The type of the rule.</typeparam>
28
+ </member>
29
+ <member name="M:bbv.Common.RuleEngine.IFactory`1.CreateRuleSet">
30
+ <summary>
31
+ Creates a rule set.
32
+ </summary>
33
+ <returns>A newly created rule set.</returns>
34
+ </member>
35
+ <member name="T:bbv.Common.RuleEngine.IValidationRuleSetDescriptor">
36
+ <summary>
37
+ A rule set descriptor for validation rules.
38
+ </summary>
39
+ </member>
40
+ <member name="T:bbv.Common.RuleEngine.IRuleSetDescriptor`2">
41
+ <summary>
42
+ All rule set descriptors have to implement this interface.
43
+ </summary>
44
+ <typeparam name="TRule">The type of the rule.</typeparam>
45
+ <typeparam name="TAggregationResult">The type of the aggregation result.</typeparam>
46
+ <remarks>
47
+ A rule set descriptor is used to define a set of rules.
48
+ On one side it is used to define what should be validated (caller of rule engine), on the other
49
+ side it defines what rules are part of the evaluation (rules provider).
50
+ </remarks>
51
+ </member>
52
+ <member name="P:bbv.Common.RuleEngine.IRuleSetDescriptor`2.Factory">
53
+ <summary>
54
+ Gets the factory used to create needed instances of rule engine related classes.
55
+ </summary>
56
+ <value>The factory.</value>
57
+ </member>
58
+ <member name="P:bbv.Common.RuleEngine.IRuleSetDescriptor`2.Aggregator">
59
+ <summary>
60
+ Gets the aggregator that is used to combine all rules taking part in the evaluation.
61
+ </summary>
62
+ <value>The aggregator.</value>
63
+ </member>
64
+ <member name="P:bbv.Common.RuleEngine.IValidationRuleSetDescriptor.Factory">
65
+ <summary>
66
+ Gets the validation factory.
67
+ </summary>
68
+ <value>The factory.</value>
69
+ </member>
70
+ <member name="T:bbv.Common.RuleEngine.RuleEngineException">
71
+ <summary>
72
+ Thrown if there is a problem in the rule engine.
73
+ </summary>
74
+ </member>
75
+ <member name="M:bbv.Common.RuleEngine.RuleEngineException.#ctor">
76
+ <summary>
77
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.RuleEngineException"/> class.
78
+ </summary>
79
+ </member>
80
+ <member name="M:bbv.Common.RuleEngine.RuleEngineException.#ctor(System.String)">
81
+ <summary>
82
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.RuleEngineException"/> class.
83
+ </summary>
84
+ <param name="message">The message.</param>
85
+ </member>
86
+ <member name="M:bbv.Common.RuleEngine.RuleEngineException.#ctor(System.String,System.Exception)">
87
+ <summary>
88
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.RuleEngineException"/> class.
89
+ </summary>
90
+ <param name="message">The message.</param>
91
+ <param name="innerException">The inner exception.</param>
92
+ </member>
93
+ <member name="T:bbv.Common.RuleEngine.RuleProviderAttribute">
94
+ <summary>
95
+ The <see cref="T:bbv.Common.RuleEngine.RuleProviderAttribute"/> is used to mark methods as methods that provide
96
+ rules for a specific <see cref="T:bbv.Common.RuleEngine.IRuleSetDescriptor`2"/>.
97
+ </summary>
98
+ </member>
99
+ <member name="T:bbv.Common.RuleEngine.ValidationAggregator">
100
+ <summary>
101
+ The <see cref="T:bbv.Common.RuleEngine.ValidationAggregator"/> is an aggregator that combines the result of <see cref="T:bbv.Common.RuleEngine.IValidationRule"/>s
102
+ into a single <see cref="T:bbv.Common.RuleEngine.IValidationResult"/>.
103
+ The result is valid if all evaluated rules are valid and the list of violations of the result is the sum of all violations of all
104
+ evaluated rules.
105
+ </summary>
106
+ </member>
107
+ <member name="F:bbv.Common.RuleEngine.ValidationAggregator.log">
108
+ <summary>The logger for the validation aggregator.</summary>
109
+ </member>
110
+ <member name="F:bbv.Common.RuleEngine.ValidationAggregator.validationFactory">
111
+ <summary>The validation factory used to create needed instances.</summary>
112
+ </member>
113
+ <member name="F:bbv.Common.RuleEngine.ValidationAggregator.breakOnFirstViolation">
114
+ <summary>Indicates whether the evaluation of rules should be stopped on the first violation.</summary>
115
+ </member>
116
+ <member name="M:bbv.Common.RuleEngine.ValidationAggregator.#ctor(bbv.Common.RuleEngine.IValidationFactory,System.Boolean)">
117
+ <summary>
118
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.ValidationAggregator"/> class.
119
+ </summary>
120
+ <param name="validationFactory">The validation factory.</param>
121
+ <param name="breakOnFirstViolation">if set to <c>true</c> [break on first violation].</param>
122
+ </member>
123
+ <member name="M:bbv.Common.RuleEngine.ValidationAggregator.Aggregate(bbv.Common.RuleEngine.IRuleSet{bbv.Common.RuleEngine.IValidationRule},System.String@)">
124
+ <summary>
125
+ Aggregates the specified rule set.
126
+ The result is valid if all rules are valid and it contains all violations of all rules.
127
+ </summary>
128
+ <param name="ruleSet">The rule set.</param>
129
+ <param name="logInfo">The log info. The aggregator should provide information about the results of the different rules and how they
130
+ influenced the overall result. This info is written to the log by the rule engine.</param>
131
+ <returns>
132
+ The aggregated result of all rules taking part in the evaluation.
133
+ </returns>
134
+ </member>
135
+ <member name="T:bbv.Common.RuleEngine.ValidationFactory">
136
+ <summary>
137
+ ValidationFactory creating rule engine related instances.
138
+ </summary>
139
+ </member>
140
+ <member name="T:bbv.Common.RuleEngine.IValidationFactory">
141
+ <summary>
142
+ Factory for all rule engine related instances used for validation rules.
143
+ </summary>
144
+ </member>
145
+ <member name="M:bbv.Common.RuleEngine.IValidationFactory.CreateValidationResult(System.Boolean)">
146
+ <summary>
147
+ Creates a validation result.
148
+ </summary>
149
+ <param name="valid">Initial value for <see cref="P:bbv.Common.RuleEngine.ValidationResult.Valid"/></param>
150
+ <returns>A newly created validation result.</returns>
151
+ </member>
152
+ <member name="M:bbv.Common.RuleEngine.IValidationFactory.CreateValidationViolation(System.String,System.Object[])">
153
+ <summary>
154
+ <para>Creates a validation violation.</para>
155
+ <para>Use this overload if you do not have an associated message.</para>
156
+ </summary>
157
+ <param name="reason">The reason.</param>
158
+ <param name="reasonArguments">The arguments used in the <paramref name="reason"/> format string.</param>
159
+ <returns>A newly created validation violation.</returns>
160
+ </member>
161
+ <member name="M:bbv.Common.RuleEngine.IValidationFactory.CreateValidationViolation(System.String,System.Guid,System.Object[])">
162
+ <summary>
163
+ <para>Creates a validation violation.</para>
164
+ <para>Use this overload if you have an associated message.</para>
165
+ </summary>
166
+ <param name="reason">The reason for this validation.</param>
167
+ <param name="messageId">The GUID of the message describing the reason for this violation.</param>
168
+ <param name="messageArguments">The arguments used in the message referenced by <paramref name="messageId"/>.</param>
169
+ <returns>A newly created validation violation.</returns>
170
+ </member>
171
+ <member name="M:bbv.Common.RuleEngine.IValidationFactory.CreateValidationViolation(System.Object,System.String,System.Guid,System.Object[])">
172
+ <summary>
173
+ Creates a validation violation.
174
+ </summary>
175
+ <param name="data">Object containing detailed information about the violation.</param>
176
+ <param name="reason">The reason.</param>
177
+ <param name="messageId">The GUID identifying the message describing the reason.</param>
178
+ <param name="messageArguments">The message arguments.</param>
179
+ <returns>A newly created validation violation.</returns>
180
+ </member>
181
+ <member name="M:bbv.Common.RuleEngine.ValidationFactory.CreateValidationResult(System.Boolean)">
182
+ <summary>
183
+ Creates a validation result.
184
+ </summary>
185
+ <param name="valid">Initial value for <see cref="P:bbv.Common.RuleEngine.ValidationResult.Valid"/></param>
186
+ <returns>A newly created validation result.</returns>
187
+ </member>
188
+ <member name="M:bbv.Common.RuleEngine.ValidationFactory.CreateRuleSet">
189
+ <summary>
190
+ Creates a rule set.
191
+ </summary>
192
+ <returns>A newly created rule set.</returns>
193
+ </member>
194
+ <member name="M:bbv.Common.RuleEngine.ValidationFactory.CreateValidationViolation(System.String,System.Object[])">
195
+ <summary>
196
+ <para>Creates a validation violation.</para>
197
+ <para>Use this overload if you do not have an associated message.</para>
198
+ </summary>
199
+ <param name="reason">The reason.</param>
200
+ <param name="reasonArguments">The arguments used in the <paramref name="reason"/> format string.</param>
201
+ <returns>A newly created validation violation.</returns>
202
+ </member>
203
+ <member name="M:bbv.Common.RuleEngine.ValidationFactory.CreateValidationViolation(System.String,System.Guid,System.Object[])">
204
+ <summary>
205
+ <para>Creates a validation violation.</para>
206
+ <para>Use this overload if you have an associated message.</para>
207
+ </summary>
208
+ <param name="reason">The reason for this validation.</param>
209
+ <param name="messageId">The GUID of the message describing the reason for this violation.</param>
210
+ <param name="messageArguments">The arguments used in the message referenced by <paramref name="messageId"/>.</param>
211
+ <returns>A newly created validation violation.</returns>
212
+ </member>
213
+ <member name="M:bbv.Common.RuleEngine.ValidationFactory.CreateValidationViolation(System.Object,System.String,System.Guid,System.Object[])">
214
+ <summary>
215
+ Creates a validation violation.
216
+ </summary>
217
+ <param name="data">Object containing detailed information about the violation.</param>
218
+ <param name="reason">The reason.</param>
219
+ <param name="messageId">The GUID identifying the message describing the reason.</param>
220
+ <param name="messageArguments">The message args.</param>
221
+ <returns>A newly created validation violation.</returns>
222
+ </member>
223
+ <member name="T:bbv.Common.RuleEngine.IRule`1">
224
+ <summary>
225
+ Represents a rule that can be executed.
226
+ </summary>
227
+ <typeparam name="TResult">The type of the result.</typeparam>
228
+ </member>
229
+ <member name="M:bbv.Common.RuleEngine.IRule`1.Evaluate">
230
+ <summary>
231
+ Evaluates this instance.
232
+ </summary>
233
+ <returns>The result of the evaluation.</returns>
234
+ </member>
235
+ <member name="T:bbv.Common.RuleEngine.IRuleEngine">
236
+ <summary>
237
+ The rule engine is the central component for checking of logical rules.
238
+ </summary>
239
+ </member>
240
+ <member name="M:bbv.Common.RuleEngine.IRuleEngine.Evaluate``2(bbv.Common.RuleEngine.IRuleSetDescriptor{``0,``1})">
241
+ <summary>
242
+ Evaluates the rules specified by the rule set descriptor.
243
+ </summary>
244
+ <typeparam name="TRule">The type of the rule.</typeparam>
245
+ <typeparam name="TAggregationResult">The type of the aggregation result.</typeparam>
246
+ <param name="ruleSetDescriptor">The rule set descriptor.</param>
247
+ <returns>The result of the validation.</returns>
248
+ </member>
249
+ <member name="T:bbv.Common.RuleEngine.IRuleSet`1">
250
+ <summary>
251
+ A <see cref="T:bbv.Common.RuleEngine.IRuleSet`1"/> defines a set of rules.
252
+ </summary>
253
+ <typeparam name="TRule">The type of the rule contained in the list.</typeparam>
254
+ </member>
255
+ <member name="M:bbv.Common.RuleEngine.IRuleSet`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
256
+ <summary>
257
+ Adds several rules at once.
258
+ </summary>
259
+ <param name="rules">The rules.</param>
260
+ </member>
261
+ <member name="T:bbv.Common.RuleEngine.IRulesProvider">
262
+ <summary>
263
+ A rule provider provides set of rules that have to be checked.
264
+ </summary>
265
+ </member>
266
+ <member name="M:bbv.Common.RuleEngine.IRulesProvider.GetRules``2(bbv.Common.RuleEngine.IRuleSetDescriptor{``0,``1})">
267
+ <summary>
268
+ Returns the rules described by the specified rule set descriptor.
269
+ </summary>
270
+ <typeparam name="TRule">The type of the rule.</typeparam>
271
+ <typeparam name="TAggregationResult">The type of the aggregation result.</typeparam>
272
+ <param name="ruleSetDescriptor">The rule set descriptor.</param>
273
+ <returns>A set of rules to be validated.</returns>
274
+ </member>
275
+ <member name="T:bbv.Common.RuleEngine.IRulesProviderFinder">
276
+ <summary>
277
+ The <see cref="T:bbv.Common.RuleEngine.RuleEngine"/> uses a <see cref="T:bbv.Common.RuleEngine.IRulesProviderFinder"/> to get
278
+ all <see cref="T:bbv.Common.RuleEngine.IRulesProvider"/> relevant for a <see cref="T:bbv.Common.RuleEngine.IRuleSetDescriptor`2"/>.
279
+ </summary>
280
+ </member>
281
+ <member name="M:bbv.Common.RuleEngine.IRulesProviderFinder.FindRulesProviders``2(bbv.Common.RuleEngine.IRuleSetDescriptor{``0,``1})">
282
+ <summary>
283
+ Finds the rule providers.
284
+ </summary>
285
+ <typeparam name="TRule">The type of the rule.</typeparam>
286
+ <typeparam name="TAggregationResult">The type of the aggregation result.</typeparam>
287
+ <param name="ruleSetDescriptor">The rule set descriptor.</param>
288
+ <returns>
289
+ List of rules providers to be asked for rules for the rule descriptor.
290
+ </returns>
291
+ </member>
292
+ <member name="T:bbv.Common.RuleEngine.IValidationResult">
293
+ <summary>
294
+ Represents the result of a validation.
295
+ </summary>
296
+ </member>
297
+ <member name="P:bbv.Common.RuleEngine.IValidationResult.Valid">
298
+ <summary>
299
+ Gets or sets a value indicating whether this <see cref="T:bbv.Common.RuleEngine.IValidationResult"/> is valid.
300
+ </summary>
301
+ <value><c>true</c> if valid; otherwise, <c>false</c>.</value>
302
+ </member>
303
+ <member name="P:bbv.Common.RuleEngine.IValidationResult.Violations">
304
+ <summary>
305
+ Gets the violations.
306
+ Is an empty list if <see cref="P:bbv.Common.RuleEngine.IValidationResult.Valid"/> is <c>true</c>.
307
+ </summary>
308
+ <value>The violations.</value>
309
+ </member>
310
+ <member name="T:bbv.Common.RuleEngine.IValidationRule">
311
+ <summary>
312
+ Defines a rule for validation.
313
+ </summary>
314
+ </member>
315
+ <member name="T:bbv.Common.RuleEngine.IValidationViolation">
316
+ <summary>
317
+ Describes the reason why an <see cref="T:bbv.Common.RuleEngine.IValidationResult"/> is failed.
318
+ <para>
319
+ You can use either the <see cref="P:bbv.Common.RuleEngine.IValidationViolation.Reason"/> to describe why the validation failed
320
+ or the <see cref="P:bbv.Common.RuleEngine.IValidationViolation.MessageId"/> to identify a message or a combination of both.
321
+ </para>
322
+ </summary>
323
+ </member>
324
+ <member name="P:bbv.Common.RuleEngine.IValidationViolation.Reason">
325
+ <summary>
326
+ Gets or sets the reason for the violation.
327
+ </summary>
328
+ <value>The reason.</value>
329
+ </member>
330
+ <member name="P:bbv.Common.RuleEngine.IValidationViolation.MessageId">
331
+ <summary>
332
+ Gets or sets the GUID to identify messages used to describe the reason.
333
+ </summary>
334
+ <value>The message GUID.</value>
335
+ </member>
336
+ <member name="P:bbv.Common.RuleEngine.IValidationViolation.MessageArguments">
337
+ <summary>
338
+ Gets or sets the arguments used in the message identified by <see cref="P:bbv.Common.RuleEngine.IValidationViolation.MessageId"/>.
339
+ </summary>
340
+ <value>The message arguments.</value>
341
+ </member>
342
+ <member name="P:bbv.Common.RuleEngine.IValidationViolation.Data">
343
+ <summary>
344
+ Gets or sets an object describing the violation in detail.
345
+ You can use this property to communicate the details about the violation to the caller
346
+ of the validation.
347
+ </summary>
348
+ <value>Object describing the violation in detail.</value>
349
+ </member>
350
+ <member name="T:bbv.Common.RuleEngine.RuleEngine">
351
+ <summary>
352
+ The rule engine is the central component for checking logical rules.
353
+ </summary>
354
+ <remarks>
355
+ The rule engine takes a <see cref="T:bbv.Common.RuleEngine.IRuleSetDescriptor`2"/> as a parameter to
356
+ the <see cref="M:bbv.Common.RuleEngine.RuleEngine.Evaluate``2(bbv.Common.RuleEngine.IRuleSetDescriptor{``0,``1})"/>
357
+ method. Then it uses the <see cref="T:bbv.Common.RuleEngine.IRulesProviderFinder"/> to get the rules providers relevant
358
+ for this descriptor (this allows different rules providers in your system (for example for plug-ins)).
359
+ To get all rules that need to be checked, the rule engine calls on all found rules provider the
360
+ <see cref="M:bbv.Common.RuleEngine.IRulesProvider.GetRules``2(bbv.Common.RuleEngine.IRuleSetDescriptor{``0,``1})"/> method, which returns all rules relevant for the specified
361
+ <see cref="T:bbv.Common.RuleEngine.IRuleSetDescriptor`2"/>. Finally the rule engine aggregates the results of all checked rules together
362
+ into one <see cref="T:bbv.Common.RuleEngine.IValidationResult"/> eventually containing a set of <see cref="T:bbv.Common.RuleEngine.IValidationViolation"/>s.
363
+ </remarks>
364
+ </member>
365
+ <member name="F:bbv.Common.RuleEngine.RuleEngine.log">
366
+ <summary>
367
+ The logger for the rule engine.
368
+ </summary>
369
+ </member>
370
+ <member name="F:bbv.Common.RuleEngine.RuleEngine.rulesProviderFinder">
371
+ <summary>
372
+ The rules provider finder that is asked for rule providers for a rule descriptor.
373
+ </summary>
374
+ </member>
375
+ <member name="M:bbv.Common.RuleEngine.RuleEngine.#ctor(bbv.Common.RuleEngine.IRulesProviderFinder)">
376
+ <summary>
377
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.RuleEngine"/> class.
378
+ </summary>
379
+ <param name="rulesProviderFinder">The rules provider finder.</param>
380
+ </member>
381
+ <member name="M:bbv.Common.RuleEngine.RuleEngine.Evaluate``2(bbv.Common.RuleEngine.IRuleSetDescriptor{``0,``1})">
382
+ <summary>
383
+ Evaluates the rules specified by the rule set descriptor.
384
+ </summary>
385
+ <typeparam name="TRule">The type of the rule.</typeparam>
386
+ <typeparam name="TAggregationResult">The type of the aggregation result.</typeparam>
387
+ <param name="ruleSetDescriptor">The rule set descriptor describing which rules have to be evaluated.</param>
388
+ <returns>The result of the validation.</returns>
389
+ </member>
390
+ <member name="T:bbv.Common.RuleEngine.RuleSet`1">
391
+ <summary>
392
+ Defines a set of rules.
393
+ </summary>
394
+ <typeparam name="TRule">The type of the rule.</typeparam>
395
+ </member>
396
+ <member name="M:bbv.Common.RuleEngine.RuleSet`1.bbv#Common#RuleEngine#IRuleSet{TRule}#AddRange(System.Collections.Generic.IEnumerable{`0})">
397
+ <summary>
398
+ Defines a set of rules.
399
+ </summary>
400
+ <typeparam name="TRule">The type of the rule.</typeparam>
401
+ </member>
402
+ <member name="T:bbv.Common.RuleEngine.RulesProviderBase">
403
+ <summary>
404
+ Abstract base class for classes implementing <see cref="T:bbv.Common.RuleEngine.IRulesProvider"/>.
405
+ <para>
406
+ Provides automatic calling of GetRules method based on the <see cref="T:bbv.Common.RuleEngine.IRuleSetDescriptor`2"/>.
407
+ </para>
408
+ </summary>
409
+ <remarks>
410
+ <para>
411
+ <see cref="T:bbv.Common.RuleEngine.RuleEngine"/> will create <see cref="T:bbv.Common.RuleEngine.IRulesProvider"/>s with a
412
+ <see cref="T:bbv.Common.RuleEngine.IValidationFactory"/> parameter.
413
+ Therefore a rules provider has to provide a matching constructor.
414
+ </para>
415
+ <para>
416
+ To simplify the matching of <see cref="T:bbv.Common.RuleEngine.IRuleSetDescriptor`2"/>s to <see cref="T:bbv.Common.RuleEngine.IRuleSet`1"/> this class
417
+ implements the <see cref="M:bbv.Common.RuleEngine.RulesProviderBase.GetRules``2(bbv.Common.RuleEngine.IRuleSetDescriptor{``0,``1})"/> method by calling the method of the derived rules provider that
418
+ has the signature <code>private IRuleSet GetRules(T ruleSetDescriptor)</code> with the matching rule set
419
+ descriptor type (<code>T</code>) via reflection.
420
+ </para>
421
+ </remarks>
422
+ </member>
423
+ <member name="F:bbv.Common.RuleEngine.RulesProviderBase.Log">
424
+ <summary>
425
+ Logger of this class.
426
+ </summary>
427
+ </member>
428
+ <member name="F:bbv.Common.RuleEngine.RulesProviderBase.mapping">
429
+ <summary>
430
+ Mapping from rule descriptor types to delegates (the method that has to be called for the rule descriptor).
431
+ </summary>
432
+ </member>
433
+ <member name="M:bbv.Common.RuleEngine.RulesProviderBase.#ctor">
434
+ <summary>
435
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.RulesProviderBase"/> class and reflects the base class for rule provider methods.
436
+ </summary>
437
+ </member>
438
+ <member name="M:bbv.Common.RuleEngine.RulesProviderBase.GetRules``2(bbv.Common.RuleEngine.IRuleSetDescriptor{``0,``1})">
439
+ <summary>
440
+ Returns the rules described by the specified rule set descriptor
441
+ by calling the corresponding provider method of the derived class.
442
+ See remarks of class description for more details.
443
+ </summary>
444
+ <typeparam name="TRule">The type of the rule.</typeparam>
445
+ <typeparam name="TAggregationResult">The type of the aggregation result.</typeparam>
446
+ <param name="ruleSetDescriptor">The rule set descriptor.</param>
447
+ <returns>A set of rules to be validated.</returns>
448
+ </member>
449
+ <member name="M:bbv.Common.RuleEngine.RulesProviderBase.InitRuleSetDescriptorMapping">
450
+ <summary>
451
+ Initializes the rule set descriptor mapping used to map from rule set descriptor type to rules providing method.
452
+ </summary>
453
+ <returns>Mapping from rule descriptor types to handler methods.</returns>
454
+ </member>
455
+ <member name="M:bbv.Common.RuleEngine.RulesProviderBase.CheckNoPrivateRuleProviderMethods">
456
+ <summary>
457
+ Checks that no private methods are marked as rule provider.
458
+ </summary>
459
+ </member>
460
+ <member name="M:bbv.Common.RuleEngine.RulesProviderBase.CheckNoStaticRuleProviderMethods">
461
+ <summary>
462
+ Checks that no static methods are marked as rule provider.
463
+ </summary>
464
+ </member>
465
+ <member name="M:bbv.Common.RuleEngine.RulesProviderBase.InterfaceFilter(System.Type,System.Object)">
466
+ <summary>
467
+ Filter method to filter for interfaces. Used in <see cref="M:bbv.Common.RuleEngine.RulesProviderBase.InitRuleSetDescriptorMapping"/>.
468
+ </summary>
469
+ <param name="type">The type to match against the criteria.</param>
470
+ <param name="criteria">The criteria.</param>
471
+ <returns>A value indicating if <paramref name="type"/> matches the <paramref name="criteria"/>.</returns>
472
+ </member>
473
+ <member name="T:bbv.Common.RuleEngine.RulesProviderBase.RuleProviderMethod`2">
474
+ <summary>
475
+ Delegate for calling specific rules providing method.
476
+ </summary>
477
+ <param name="ruleSetDescriptor">The rule set descriptor for which rules are requested.</param>
478
+ <returns>The rule set containing all rules relevant for the rule set descriptor.</returns>
479
+ <typeparam name="TRuleSet">The type of the rule set.</typeparam>
480
+ <typeparam name="T">Type of the rule set descriptor.</typeparam>
481
+ </member>
482
+ <member name="T:bbv.Common.RuleEngine.ValidationResult">
483
+ <summary>
484
+ Represents the result of a validation.
485
+ </summary>
486
+ </member>
487
+ <member name="F:bbv.Common.RuleEngine.ValidationResult.violations">
488
+ <summary>
489
+ A list of violations associated with this validation result.
490
+ </summary>
491
+ </member>
492
+ <member name="M:bbv.Common.RuleEngine.ValidationResult.#ctor(System.Boolean)">
493
+ <summary>
494
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.ValidationResult"/> class.
495
+ </summary>
496
+ <param name="valid">if set to <c>true</c> [valid].</param>
497
+ </member>
498
+ <member name="P:bbv.Common.RuleEngine.ValidationResult.Valid">
499
+ <summary>
500
+ Gets or sets a value indicating whether this <see cref="T:bbv.Common.RuleEngine.IValidationResult"/> is valid.
501
+ </summary>
502
+ <value><c>true</c> if valid; otherwise, <c>false</c>.</value>
503
+ </member>
504
+ <member name="P:bbv.Common.RuleEngine.ValidationResult.Violations">
505
+ <summary>
506
+ Gets the violations.
507
+ Is an empty list if <see cref="P:bbv.Common.RuleEngine.IValidationResult.Valid"/> is <c>true</c>.
508
+ </summary>
509
+ <value>The violations.</value>
510
+ </member>
511
+ <member name="T:bbv.Common.RuleEngine.ValidationRuleBase">
512
+ <summary>
513
+ Base class for validation rules.
514
+ <para>
515
+ Provides a <see cref="T:bbv.Common.RuleEngine.IValidationFactory"/>.
516
+ </para>
517
+ </summary>
518
+ </member>
519
+ <member name="F:bbv.Common.RuleEngine.ValidationRuleBase.validationFactory">
520
+ <summary>
521
+ The validationFactory that is provided to derived classes. It is passed in the constructor.
522
+ </summary>
523
+ </member>
524
+ <member name="M:bbv.Common.RuleEngine.ValidationRuleBase.#ctor(bbv.Common.RuleEngine.IValidationFactory)">
525
+ <summary>
526
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.ValidationRuleBase"/> class.
527
+ </summary>
528
+ <param name="validationFactory">The factory for creating rule engine related instances.</param>
529
+ </member>
530
+ <member name="M:bbv.Common.RuleEngine.ValidationRuleBase.Evaluate">
531
+ <summary>
532
+ Validates this rule.
533
+ </summary>
534
+ <returns>The result of the validation.</returns>
535
+ </member>
536
+ <member name="P:bbv.Common.RuleEngine.ValidationRuleBase.ValidationFactory">
537
+ <summary>
538
+ Gets the validation factory for creating rule engine related instances.
539
+ </summary>
540
+ <value>The validation factory.</value>
541
+ </member>
542
+ <member name="T:bbv.Common.RuleEngine.ValidationRuleSet">
543
+ <summary>
544
+ A <see cref="T:bbv.Common.RuleEngine.ValidationRuleSet"/> is a <see cref="T:bbv.Common.RuleEngine.RuleSet`1"/> specifically for
545
+ <see cref="T:bbv.Common.RuleEngine.IValidationRule"/>s.
546
+ </summary>
547
+ </member>
548
+ <member name="T:bbv.Common.RuleEngine.ValidationRuleSetDescriptor">
549
+ <summary>
550
+ A rule set descriptor for validation rules.
551
+ </summary>
552
+ </member>
553
+ <member name="F:bbv.Common.RuleEngine.ValidationRuleSetDescriptor.factory">
554
+ <summary>The validation factory.</summary>
555
+ </member>
556
+ <member name="F:bbv.Common.RuleEngine.ValidationRuleSetDescriptor.aggregator">
557
+ <summary>The validation aggregator.</summary>
558
+ </member>
559
+ <member name="M:bbv.Common.RuleEngine.ValidationRuleSetDescriptor.#ctor">
560
+ <summary>
561
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.ValidationRuleSetDescriptor"/> class
562
+ that does not stop on the first violation, all rules are evaluated.
563
+ </summary>
564
+ </member>
565
+ <member name="M:bbv.Common.RuleEngine.ValidationRuleSetDescriptor.#ctor(System.Boolean)">
566
+ <summary>
567
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.ValidationRuleSetDescriptor"/> class.
568
+ </summary>
569
+ <param name="breakOnFirstViolation">if set to <c>true</c> the aggregation of rules is
570
+ stopped when the first violation occurs, all remaining rules are not evaluated.].</param>
571
+ </member>
572
+ <member name="P:bbv.Common.RuleEngine.ValidationRuleSetDescriptor.Factory">
573
+ <summary>
574
+ Gets the factory used to create needed instances of rule engine related classes.
575
+ </summary>
576
+ <value>The factory.</value>
577
+ </member>
578
+ <member name="P:bbv.Common.RuleEngine.ValidationRuleSetDescriptor.bbv#Common#RuleEngine#IRuleSetDescriptor{bbv#Common#RuleEngine#IValidationRule@bbv#Common#RuleEngine#IValidationResult}#Factory">
579
+ <summary>
580
+ Gets the factory used to create needed instances of rule engine related classes.
581
+ </summary>
582
+ <value>The factory.</value>
583
+ </member>
584
+ <member name="P:bbv.Common.RuleEngine.ValidationRuleSetDescriptor.Aggregator">
585
+ <summary>
586
+ Gets the aggregator that is used to combine all rules taking part in the evaluation.
587
+ </summary>
588
+ <value>The aggregator.</value>
589
+ </member>
590
+ <member name="T:bbv.Common.RuleEngine.ValidationViolation">
591
+ <summary>
592
+ Describes the reason why a validation failed.
593
+ A <see cref="T:bbv.Common.RuleEngine.IValidationRule"/> can generate multiple violations.
594
+ </summary>
595
+ </member>
596
+ <member name="M:bbv.Common.RuleEngine.ValidationViolation.#ctor">
597
+ <summary>
598
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.ValidationViolation"/> class.
599
+ </summary>
600
+ </member>
601
+ <member name="M:bbv.Common.RuleEngine.ValidationViolation.#ctor(System.String)">
602
+ <summary>
603
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.ValidationViolation"/> class.
604
+ </summary>
605
+ <param name="reason">The reason why the validation rule failed.</param>
606
+ </member>
607
+ <member name="M:bbv.Common.RuleEngine.ValidationViolation.#ctor(System.String,System.Guid,System.Object[])">
608
+ <summary>
609
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.ValidationViolation"/> class.
610
+ </summary>
611
+ <param name="reason">The reason.</param>
612
+ <param name="messageId">The message GUID.</param>
613
+ <param name="messageArguments">The message arguments.</param>
614
+ </member>
615
+ <member name="M:bbv.Common.RuleEngine.ValidationViolation.#ctor(System.Object,System.String,System.Guid,System.Object[])">
616
+ <summary>
617
+ Initializes a new instance of the <see cref="T:bbv.Common.RuleEngine.ValidationViolation"/> class.
618
+ </summary>
619
+ <param name="data">Object containing detailed information about the violation.</param>
620
+ <param name="reason">The reason.</param>
621
+ <param name="messageId">The message GUID.</param>
622
+ <param name="messageArguments">The message arguments.</param>
623
+ </member>
624
+ <member name="M:bbv.Common.RuleEngine.ValidationViolation.ToString">
625
+ <summary>
626
+ Returns a <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
627
+ </summary>
628
+ <returns>
629
+ A <see cref="T:System.String"></see> that represents the current <see cref="T:System.Object"></see>.
630
+ </returns>
631
+ </member>
632
+ <member name="P:bbv.Common.RuleEngine.ValidationViolation.Reason">
633
+ <summary>
634
+ Gets or sets the reason for the violation.
635
+ </summary>
636
+ <value>The reason.</value>
637
+ </member>
638
+ <member name="P:bbv.Common.RuleEngine.ValidationViolation.MessageId">
639
+ <summary>
640
+ Gets or sets the GUID to identify messages used to describe the reason.
641
+ </summary>
642
+ <value>The message GUID.</value>
643
+ </member>
644
+ <member name="P:bbv.Common.RuleEngine.ValidationViolation.MessageArguments">
645
+ <summary>
646
+ Gets or sets the arguments used in the message identified by <see cref="P:bbv.Common.RuleEngine.IValidationViolation.MessageId"/>.
647
+ </summary>
648
+ <value>The message arguments.</value>
649
+ </member>
650
+ <member name="P:bbv.Common.RuleEngine.ValidationViolation.Data">
651
+ <summary>
652
+ Gets or sets an object describing the violation in detail.
653
+ You can use this property to communicate the details about the violation to the caller
654
+ of the validation.
655
+ </summary>
656
+ <value>The data that explains the violation in detail.</value>
657
+ </member>
658
+ </members>
659
+ </doc>