CSLA.NET 6.0.0
CSLA .NET is a software development framework that helps you build a reusable, maintainable object-oriented business layer for your app.
Csla.Rules.RuleResult Class Reference

Contains information about the result of a rule. More...

Public Member Functions

 RuleResult (string ruleName, Core.IPropertyInfo property)
 Creates a successful result. More...
 
 RuleResult (string ruleName, Core.IPropertyInfo property, string description)
 Creates a failure result. More...
 

Properties

string RuleName [get]
 Gets the unique name of the rule that created this result. More...
 
bool Success [get]
 Gets a value indicating whether the rule was successful. More...
 
string Description [get]
 Gets a human-readable description of why the rule failed. More...
 
RuleSeverity Severity [getset]
 Gets or sets the severity of a failed rule. More...
 
bool StopProcessing [getset]
 Gets or sets a value indicating whether rule processing should immediately stop (applies to sync rules only). More...
 
Csla.Core.IPropertyInfo PrimaryProperty [get]
 Gets the primary property for this result. More...
 
List< Core.IPropertyInfoProperties [getset]
 Gets or sets a list of properties that were affected by the rule, so appropriate PropertyChanged events can be raised for UI notification. More...
 
Dictionary< Core.IPropertyInfo, object > OutputPropertyValues [getset]
 Gets or sets a dictionary of new property values used to update the business object's properties after the rule is complete. More...
 

Detailed Description

Contains information about the result of a rule.

Definition at line 19 of file RuleResult.cs.

Constructor & Destructor Documentation

◆ RuleResult() [1/2]

Csla.Rules.RuleResult.RuleResult ( string  ruleName,
Core.IPropertyInfo  property 
)

Creates a successful result.

Parameters
ruleNameUnique name of the rule creating this result.
propertyProperty to which this result should be attached.

Definition at line 70 of file RuleResult.cs.

◆ RuleResult() [2/2]

Csla.Rules.RuleResult.RuleResult ( string  ruleName,
Core.IPropertyInfo  property,
string  description 
)

Creates a failure result.

Parameters
ruleNameUnique name of the rule creating this result.
propertyProperty to which this result should be attached.
descriptionHuman-readable description of why the rule failed.

Definition at line 87 of file RuleResult.cs.

Property Documentation

◆ Description

string Csla.Rules.RuleResult.Description
get

Gets a human-readable description of why the rule failed.

Definition at line 35 of file RuleResult.cs.

◆ OutputPropertyValues

Dictionary<Core.IPropertyInfo, object> Csla.Rules.RuleResult.OutputPropertyValues
getset

Gets or sets a dictionary of new property values used to update the business object's properties after the rule is complete.

Definition at line 61 of file RuleResult.cs.

◆ PrimaryProperty

Csla.Core.IPropertyInfo Csla.Rules.RuleResult.PrimaryProperty
get

Gets the primary property for this result.

Definition at line 49 of file RuleResult.cs.

◆ Properties

List<Core.IPropertyInfo> Csla.Rules.RuleResult.Properties
getset

Gets or sets a list of properties that were affected by the rule, so appropriate PropertyChanged events can be raised for UI notification.

Definition at line 55 of file RuleResult.cs.

◆ RuleName

string Csla.Rules.RuleResult.RuleName
get

Gets the unique name of the rule that created this result.

Definition at line 25 of file RuleResult.cs.

◆ Severity

RuleSeverity Csla.Rules.RuleResult.Severity
getset

Gets or sets the severity of a failed rule.

Definition at line 39 of file RuleResult.cs.

◆ StopProcessing

bool Csla.Rules.RuleResult.StopProcessing
getset

Gets or sets a value indicating whether rule processing should immediately stop (applies to sync rules only).

Definition at line 45 of file RuleResult.cs.

◆ Success

bool Csla.Rules.RuleResult.Success
get

Gets a value indicating whether the rule was successful.

Definition at line 30 of file RuleResult.cs.