Context information provided to a business rule when it is invoked. More...

Inheritance diagram for Csla.Rules.RuleContext:

Public Member Functions

void ExecuteRule (IBusinessRuleBase innerRule)

Executes the inner rule from the outer rules context. Creates a chained context and if CanRunRule will execute the inner rule.

Parameters

innerRule The inner rule.

Exceptions

ArgumentNullException innerRule is null.

RuleContext (ApplicationContext applicationContext, Action< IRuleContext > completeHandler, IBusinessRuleBase rule, object? target, Dictionary< IPropertyInfo, object?> inputPropertyValues, RuleContextModes executeContext=RuleContextModes.PropertyChanged)

Creates a RuleContext instance for unit tests.

IRuleContext GetChainedContext (IBusinessRuleBase rule)

Gets a new RuleContext object for a chained rule.

Parameters

rule	Chained rule that will use this new context.

The properties from the existing RuleContext will be used to create the new context, with the exception of the Rule property which is set using the supplied IBusinessRule value.

void AddErrorResult (string description)

Add a Error severity result to the Results list.

Parameters

description Human-readable description of why the rule failed.

Exceptions

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

void AddErrorResult (string description, bool stopProcessing)

Add a Error severity result to the Results list.

Parameters

description	Human-readable description of why the rule failed.
stopProcessing	True if no further rules should be processed for the current property.

Exceptions

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

void AddErrorResult (IPropertyInfo property, string description)

Add a Error severity result to the Results list. This method is only allowed on "object" level rules to allow an object level rule to set warning result on a field.

Parameters

property	Property to which the result applies.
description	Human-readable description of why the rule failed.

Exceptions

ArgumentNullException	property is `null`.
System.ArgumentOutOfRangeException	When property is not defined in AffectedProperties list.
ArgumentException	description is `null`, string.Empty or only consists of white spaces.

void AddWarningResult (string description)

Add a Warning severity result to the Results list.

Parameters

description Human-readable description of why the rule failed.

Exceptions

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

void AddWarningResult (string description, bool stopProcessing)

Add a Warning severity result to the Results list.

Parameters

description	Human-readable description of why the rule failed.
stopProcessing	True if no further rules should be processed for the current property.

Exceptions

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

void AddWarningResult (IPropertyInfo property, string description)

Add a Warning severity result to the Results list. This method is only allowed on "object" level rules to allow an object level rule to set warning result on a field.

Parameters

property	Property to which the result applies.
description	Human-readable description of why the rule failed.

Exceptions

ArgumentNullException	property is `null`.
System.ArgumentOutOfRangeException	When property is not defined in AffectedProperties list.
ArgumentException	description is `null`, string.Empty or only consists of white spaces.

void AddInformationResult (string description)

Add an Information severity result to the Results list.

Parameters

description Human-readable description of why the rule failed.

Exceptions

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

void AddInformationResult (string description, bool stopProcessing)

Add an Information severity result to the Results list.

Parameters

description	Human-readable description of why the rule failed.
stopProcessing	True if no further rules should be processed for the current property.

Exceptions

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

void AddInformationResult (IPropertyInfo property, string description)

Add an Information severity result to the Results list. This method is only allowed on "object" level rules to allow an object level rule to set warning result on a field.

Parameters

property	Property to which the result applies.
description	Human-readable description of why the rule failed.

Exceptions

ArgumentNullException	property is `null`.
System.ArgumentOutOfRangeException	When property is not defined in AffectedProperties list.
ArgumentException	description is `null`, string.Empty or only consists of white spaces.

void AddSuccessResult (bool stopProcessing)

Add a Success severity result to the Results list.

Parameters

stopProcessing True if no further rules should be processed for the current property.

void AddOutValue (object? value)

Add an outbound value to update the rule's primary property on the business object once the rule is complete.

Parameters

value New property value.

Exceptions

InvalidOperationException Rule.IBusinessRuleBase.PrimaryProperty is null.

void AddOutValue (IPropertyInfo property, object? value)

Add an outbound value to update a property on the business object once the rule is complete.

Parameters

property	Property to update.
value	New property value.

Exceptions

ArgumentNullException	property is `null`.
System.ArgumentOutOfRangeException	When property is not defined in AffectedProperties list.

void AddDirtyProperty (IPropertyInfo property)

Adds a property name as a dirty field (changed value).

Parameters

property The property.

Exceptions

ArgumentNullException	property is `null`.
System.ArgumentOutOfRangeException

void Complete ()

Indicates that the rule processing is complete, so CSLA .NET will process the Results list. This method must be invoked on the UI thread.

T? GetInputValue<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] T > (PropertyInfo< T > propertyInfo)

Gets the value.

Template Parameters

T

Parameters

propertyInfo The property info.

Exceptions

ArgumentNullException propertyInfo is null.

T? GetInputValue< T > (IPropertyInfo propertyInfo)

Gets the value with explicit cast.

Template Parameters

T

Parameters

propertyInfo The generic property info.

Exceptions

ArgumentNullException propertyInfo is null.

bool TryGetInputValue<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] T > (PropertyInfo< T > propertyInfo, ref T? value)

Tries to get the value. Use this method on LazyLoaded properties to test if value has been provided or not.

Template Parameters

T

Parameters

propertyInfo	The generic property info.
value	The value.

Returns: true if value exists else false

Exceptions

ArgumentNullException propertyInfo is null.

bool TryGetInputValue< T > (IPropertyInfo propertyInfo, ref T? value)

Tries to get the value with explicit cast. Use this method on LazyLoaded properties to test if value has been provided or not.

Template Parameters

T

Parameters

propertyInfo	The generic property info.
value	The value.

Returns: true if value exists else false

Exceptions

ArgumentNullException propertyInfo is null.

Properties
IBusinessRuleBase	Rule `[get, set]`
	Gets the rule object.
object?	Target `[get, set]`
	Gets a reference to the target business object.
Dictionary< IPropertyInfo, object?>	InputPropertyValues `[get]`
	Gets a dictionary containing copies of property values from the target business object.
List< IPropertyInfo >	DirtyProperties `[get]`
	Gets a list of dirty properties (value was updated).The dirty properties.
Dictionary< IPropertyInfo, object?>	OutputPropertyValues `[get]`
	Gets a dictionary containing copies of property values that should be updated in the target object.
List< RuleResult >	Results `[get]`
	Gets a list of RuleResult objects containing the results of the rule.
string	OriginPropertyName `[get]`
	Gets or sets the name of the origin property.The name of the origin property.
RuleContextModes	ExecuteContext `[get, set]`
	Gets the execution context.The execution context.
bool	IsCascadeContext `[get]`
	Gets a value indicating whether this instance is cascade context as a result of AffectedProperties.`true` if this instance is cascade context; otherwise, `false`.
bool	IsPropertyChangedContext `[get]`
	Gets a value indicating whether this instance is property changed context.`true` if this instance is property changed context; otherwise, `false`.
bool	IsCheckRulesContext `[get]`
	Gets a value indicating whether this instance is check rules context.`true` if this instance is check rules context; otherwise, `false`.
bool	IsCheckObjectRulesContext `[get]`
	Gets a value indicating whether this instance is check object rules context.
ApplicationContext	ApplicationContext `[get]`
	Gets a reference to the current ApplicationContext.
IDataPortalFactory	DataPortalFactory `[get]`
	Gets a data portal factory instance.

Detailed Description

Context information provided to a business rule when it is invoked.

Constructor & Destructor Documentation

◆ RuleContext()

Csla.Rules.RuleContext.RuleContext	(	ApplicationContext	applicationContext,
		Action< IRuleContext >	completeHandler,
		IBusinessRuleBase	rule,
		object?	target,
		Dictionary< IPropertyInfo, object?>	inputPropertyValues,
		RuleContextModes	executeContext = RuleContextModes::PropertyChanged )

inline

Creates a RuleContext instance for unit tests.

Parameters

applicationContext	Current ApplicationContext
completeHandler	Callback for async rule.
rule	Reference to the rule object.
target	Target business object.
inputPropertyValues	Input property values used by the rule.
executeContext	The execution context under which the rule is running.

Exceptions

ArgumentNullException applicationContext , completeHandler , rule or inputPropertyValues is null.

Member Function Documentation

◆ AddDirtyProperty()

void Csla.Rules.RuleContext.AddDirtyProperty ( IPropertyInfo property )

inline

Adds a property name as a dirty field (changed value).

Parameters

property The property.

Exceptions

ArgumentNullException	property is `null`.
System.ArgumentOutOfRangeException

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RuleContext()

Member Function Documentation

◆ AddDirtyProperty()

◆ AddErrorResult() [1/3]

◆ AddErrorResult() [2/3]

◆ AddErrorResult() [3/3]

◆ AddInformationResult() [1/3]

◆ AddInformationResult() [2/3]

◆ AddInformationResult() [3/3]

◆ AddOutValue() [1/2]

◆ AddOutValue() [2/2]

◆ AddSuccessResult()

◆ AddWarningResult() [1/3]

◆ AddWarningResult() [2/3]

◆ AddWarningResult() [3/3]

◆ Complete()

◆ ExecuteRule()

◆ GetChainedContext()

◆ GetInputValue< T >()

◆ GetInputValue<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] T >()

◆ TryGetInputValue< T >()

◆ TryGetInputValue<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] T >()

Property Documentation

◆ ApplicationContext

◆ DataPortalFactory

◆ DirtyProperties

◆ ExecuteContext

◆ InputPropertyValues

◆ IsCascadeContext

◆ IsCheckObjectRulesContext

◆ IsCheckRulesContext

◆ IsPropertyChangedContext

◆ OriginPropertyName

◆ OutputPropertyValues

◆ Results

◆ Rule

◆ Target