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.CommonRules.Required Class Reference

Business rule for a required string. More...

Inheritance diagram for Csla.Rules.CommonRules.Required:
Csla.Rules.CommonRules.CommonBusinessRule Csla.Rules.PropertyRule Csla.Rules.BusinessRule Csla.Rules.BusinessRuleBase Csla.Rules.IBusinessRule Csla.Rules.IBusinessRuleBase Csla.Rules.IBusinessRuleBase

Public Member Functions

 Required (Csla.Core.IPropertyInfo primaryProperty)
 Creates an instance of the rule. More...
 
 Required (Csla.Core.IPropertyInfo primaryProperty, string message)
 Creates an instance of the rule. More...
 
 Required (Csla.Core.IPropertyInfo primaryProperty, Func< string > messageDelegate)
 Creates an instance of the rule. More...
 

Protected Member Functions

override string GetMessage ()
 Gets the error message. More...
 
override void Execute (IRuleContext context)
 Rule implementation. More...
 
- Protected Member Functions inherited from Csla.Rules.CommonRules.CommonBusinessRule
 CommonBusinessRule (Csla.Core.IPropertyInfo primaryProperty)
 Creates an instance of the rule. More...
 
 CommonBusinessRule ()
 Creates an instance of the rule. More...
 
- Protected Member Functions inherited from Csla.Rules.PropertyRule
 PropertyRule ()
 Initializes a new instance of the PropertyRule class. More...
 
 PropertyRule (IPropertyInfo propertyInfo)
 Initializes a new instance of the PropertyRule class. More...
 
- Protected Member Functions inherited from Csla.Rules.BusinessRule
 BusinessRule ()
 Creates an instance of the rule that applies to a business object as a whole. More...
 
 BusinessRule (Csla.Core.IPropertyInfo primaryProperty)
 Creates an instance of the rule that applies to a specfic property. More...
 
- Protected Member Functions inherited from Csla.Rules.BusinessRuleBase
void CanWriteProperty (string argument)
 Allows or blocks changing a property value. More...
 
 BusinessRuleBase (Csla.Core.IPropertyInfo primaryProperty)
 Creates an instance of the rule that applies to a specfic property. More...
 
void LoadProperty (object obj, Csla.Core.IPropertyInfo propertyInfo, object newValue)
 Loads a property's managed field with the supplied value calling PropertyHasChanged if the value does change. More...
 
object ReadProperty (object obj, Csla.Core.IPropertyInfo propertyInfo)
 Reads a property's field value. More...
 

Additional Inherited Members

- Properties inherited from Csla.Rules.CommonRules.CommonBusinessRule
RuleSeverity Severity [getset]
 Gets or sets the severity for this rule. More...
 
- Properties inherited from Csla.Rules.PropertyRule
string MessageText [getset]
 Gets or sets the error message (constant). More...
 
Func< string > MessageDelegate [getset]
 Gets or sets the error message function for this rule. More...
 
bool HasMessageDelegate [get]
 Gets a value indicating whether this instance has message delegate. More...
 
bool CanRunAsAffectedProperty [getset]
 Gets or sets a value indicating whether this instance can run as affected property. More...
 
bool CanRunOnServer [getset]
 Gets or sets a value indicating whether this instance can run in logical serverside data portal. More...
 
bool CanRunInCheckRules [getset]
 Gets or sets a value indicating whether this instance can run when CheckRules is called on BO. More...
 
- Properties inherited from Csla.Rules.BusinessRule
override bool IsAsync [getprotected set]
 Gets a value indicating whether the rule will run on a background thread. More...
 
- Properties inherited from Csla.Rules.BusinessRuleBase
bool PropertiesLocked [getset]
 Gets or sets a value indicating whether property values should be locked because an async operation is running. More...
 
virtual Csla.Core.IPropertyInfo PrimaryProperty [getset]
 Gets or sets the primary property affected by this rule. More...
 
List< Csla.Core.IPropertyInfoAffectedProperties [get]
 Gets a list of properties affected by this rule. More...
 
List< Csla.Core.IPropertyInfoInputProperties [getprotected set]
 Gets a list of secondary property values to be supplied to the rule when it is executed. More...
 
abstract bool IsAsync [getprotected set]
 Gets a value indicating whether the rule will run on a background thread. More...
 
bool ProvideTargetWhenAsync [getprotected 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). More...
 
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. More...
 
RuleUri RuleUri [getset]
 Sets or gets the rule:// URI object for this rule. More...
 
int Priority [getset]
 Gets the rule priority. More...
 
RunModes RunMode [getset]
 Gets or sets the run in context. More...
 
- Properties inherited from Csla.Rules.IBusinessRuleBase
List< Csla.Core.IPropertyInfoInputProperties [get]
 Gets a list of secondary property values to be supplied to the rule when it is executed. More...
 
List< Csla.Core.IPropertyInfoAffectedProperties [get]
 Gets a list of properties affected by this rule. More...
 
Csla.Core.IPropertyInfo PrimaryProperty [get]
 Gets the primary property affected by this rule. More...
 
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. More...
 
int Priority [get]
 Gets the rule priority. More...
 
bool ProvideTargetWhenAsync [get]
 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). More...
 
RunModes RunMode [get]
 Gets the context in which the rule is allowed to execute. More...
 
bool IsAsync [get]
 Gets a value indicating whether the Execute() method will run asynchronous code. More...
 

Detailed Description

Business rule for a required string.

Definition at line 105 of file CommonRules.cs.

Constructor & Destructor Documentation

◆ Required() [1/3]

Csla.Rules.CommonRules.Required.Required ( Csla.Core.IPropertyInfo  primaryProperty)

Creates an instance of the rule.

Parameters
primaryPropertyProperty to which the rule applies.

Definition at line 111 of file CommonRules.cs.

◆ Required() [2/3]

Csla.Rules.CommonRules.Required.Required ( Csla.Core.IPropertyInfo  primaryProperty,
string  message 
)

Creates an instance of the rule.

Parameters
primaryPropertyProperty to which the rule applies.
messageThe message.

Definition at line 123 of file CommonRules.cs.

◆ Required() [3/3]

Csla.Rules.CommonRules.Required.Required ( Csla.Core.IPropertyInfo  primaryProperty,
Func< string >  messageDelegate 
)

Creates an instance of the rule.

Parameters
primaryPropertyProperty to which the rule applies.
messageDelegateThe localizable message.

Definition at line 134 of file CommonRules.cs.

Member Function Documentation

◆ Execute()

override void Csla.Rules.CommonRules.Required.Execute ( IRuleContext  context)
protectedvirtual

Rule implementation.

Parameters
contextRule context.

Reimplemented from Csla.Rules.BusinessRule.

Definition at line 153 of file CommonRules.cs.

◆ GetMessage()

override string Csla.Rules.CommonRules.Required.GetMessage ( )
protectedvirtual

Gets the error message.

Reimplemented from Csla.Rules.PropertyRule.

Definition at line 144 of file CommonRules.cs.