Csla.Rules.RuleResult Class Reference

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

Public Member Functions
	RuleResult (string ruleName, IPropertyInfo? property, int displayIndex)
	Creates a successful result.
	RuleResult (string ruleName, IPropertyInfo? property, string description, int displayIndex)
	Creates a failure result.

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

Detailed Description

Contains information about the result of a rule.

Constructor & Destructor Documentation

RuleResult() [1/2]

Csla.Rules.RuleResult.RuleResult ( string ruleName, IPropertyInfo? property, int displayIndex )

inline

Creates a successful result.

Parameters

ruleName	Unique name of the rule creating this result.
property	Property to which this result should be attached.
displayIndex	Message's display Index in UI

Exceptions

ArgumentNullException

ruleName is null.

RuleResult() [2/2]

Csla.Rules.RuleResult.RuleResult ( string ruleName, IPropertyInfo? property, string description, int displayIndex )

inline

Creates a failure result.

Parameters

ruleName	Unique name of the rule creating this result.
property	Property to which this result should be attached.
description	Human-readable description of why the rule failed.
displayIndex	Message's display Index in UI

Exceptions

ArgumentNullException	ruleName is null.
ArgumentException	description is null, string.Empty or only consists of white spaces.

Property Documentation

Description

string Csla.Rules.RuleResult.Description

get

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

DisplayIndex

int Csla.Rules.RuleResult.DisplayIndex

getset

Gets or sets a value of Message's display Index.

OutputPropertyValues

Dictionary<IPropertyInfo, object?> Csla.Rules.RuleResult.OutputPropertyValues = []

get

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

PrimaryProperty

IPropertyInfo? Csla.Rules.RuleResult.PrimaryProperty

get

Gets the primary property for this result.

Priority

int Csla.Rules.RuleResult.Priority

getset

Gets or sets the broken rule priority.

Properties

List<IPropertyInfo> Csla.Rules.RuleResult.Properties = []

get

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

RuleName

string Csla.Rules.RuleResult.RuleName

get

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

Severity

RuleSeverity Csla.Rules.RuleResult.Severity

getset

Gets or sets the severity of a failed rule.

StopProcessing

bool Csla.Rules.RuleResult.StopProcessing

getset

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

Success

bool Csla.Rules.RuleResult.Success

get

Gets a value indicating whether the rule was successful.

---

The documentation for this class was generated from the following file:

• csla/Source/Csla/Rules/RuleResult.cs