Csla.Rules.BusinessRule Class Reference

Base class used to create business and validation rules. More...

Inheritance diagram for Csla.Rules.BusinessRule:

Protected Member Functions
	BusinessRule ()
	Creates an instance of the rule that applies to a business object as a whole.
	BusinessRule (Core.IPropertyInfo? primaryProperty)
	Creates an instance of the rule that applies to a specfic property.
virtual void	Execute (IRuleContext context)
	Business or validation rule implementation.
Protected Member Functions inherited from Csla.Rules.BusinessRuleBase
void	CanWriteProperty (string argument)
	Allows or blocks changing a property value.
	BusinessRuleBase (IPropertyInfo? primaryProperty)
	Creates an instance of the rule that applies to a specfic property.
void	LoadProperty (object obj, IPropertyInfo propertyInfo, object? newValue)
	Loads a property's managed field with the supplied value calling PropertyHasChanged if the value does change.
object?	ReadProperty (object obj, IPropertyInfo propertyInfo)
	Reads a property's field value.

Properties
override bool	IsAsync [get, protected set]
	Gets a value indicating whether the rule will run on a background thread.
Properties inherited from Csla.Rules.BusinessRuleBase
bool	CascadeIfDirty [get, protected set]
	If true, rule will only cascade if the primary property is dirty.
bool	PropertiesLocked [get, set]
	Gets or sets a value indicating whether property values should be locked because an async operation is running.
virtual ? IPropertyInfo	PrimaryProperty [get, set]
	Gets or sets the primary property affected by this rule.
List< IPropertyInfo >	AffectedProperties [get]
	Gets a list of properties affected by this rule. Rules for these properties are executed after rules for the primary property.
List< IPropertyInfo >	InputProperties [get]
	Gets a list of secondary property values to be supplied to the rule when it is executed.
bool	IsAsync [get, protected set]
	Gets a value indicating whether the rule will run on a background thread.
bool	ProvideTargetWhenAsync [get, protected set]
	Gets a value indicating that the Target property should be set even for an async rule (note that using Target from a background thread will cause major problems).
string	RuleName [get]
	Gets a unique rule:// URI for the specific instance of the rule within the context of the business object where the rule is used.
RuleUri	RuleUri [get, set]
	Sets or gets the rule:// URI object for this rule.
int	Priority [get, set]
	Gets the rule priority.
RunModes	RunMode [get, set]
	Gets or sets the run in context.
int	DisplayIndex [get, set]
	Gets the rule DisplayIndex in UI.

Detailed Description

Base class used to create business and validation rules.

Constructor & Destructor Documentation

BusinessRule() [1/2]

Csla.Rules.BusinessRule.BusinessRule ( )

inlineprotected

Creates an instance of the rule that applies to a business object as a whole.

BusinessRule() [2/2]

Csla.Rules.BusinessRule.BusinessRule ( Core.IPropertyInfo? primaryProperty )

inlineprotected

Creates an instance of the rule that applies to a specfic property.

Parameters

primaryProperty

Primary property for this rule.

Member Function Documentation

Execute()

virtual void Csla.Rules.BusinessRule.Execute ( IRuleContext context )

inlineprotectedvirtual

Business or validation rule implementation.

Parameters

context

Rule context object.

Implements Csla.Rules.IBusinessRule.

Reimplemented in Csla.Rules.CommonRules.DataAnnotation, Csla.Rules.CommonRules.InfoMessage, Csla.Rules.CommonRules.Lambda, Csla.Rules.CommonRules.MaxLength, Csla.Rules.CommonRules.MaxValue< T >, Csla.Rules.CommonRules.MinLength, Csla.Rules.CommonRules.MinValue< T >, Csla.Rules.CommonRules.RegExMatch, and Csla.Rules.CommonRules.Required.

Property Documentation

IsAsync

override bool Csla.Rules.BusinessRule.IsAsync

getprotected set

Gets a value indicating whether the rule will run on a background thread.

Implements Csla.Rules.IBusinessRuleBase.

---

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

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