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

Object providing extra information to methods that implement business rules. More...

Inheritance diagram for Csla.Validation.DecoratedRuleArgs:
Csla.Validation.RuleArgs Csla.Validation.CommonRules.IntegerMaxValueRuleArgs Csla.Validation.CommonRules.IntegerMinValueRuleArgs Csla.Validation.CommonRules.MaxLengthRuleArgs Csla.Validation.CommonRules.MaxValueRuleArgs< T > Csla.Validation.CommonRules.MinLengthRuleArgs Csla.Validation.CommonRules.MinValueRuleArgs< T > Csla.Validation.CommonRules.RegExRuleArgs

Public Member Functions

 DecoratedRuleArgs (string propertyName)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (Core.IPropertyInfo propertyInfo)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, string friendlyName)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, RuleSeverity severity)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (Core.IPropertyInfo propertyInfo, RuleSeverity severity)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, string friendlyName, RuleSeverity severity)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, RuleSeverity severity, bool stopProcessing)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (Core.IPropertyInfo propertyInfo, RuleSeverity severity, bool stopProcessing)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, string friendlyName, RuleSeverity severity, bool stopProcessing)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, Dictionary< string, object > args)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (Core.IPropertyInfo propertyInfo, Dictionary< string, object > args)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, string friendlyName, Dictionary< string, object > args)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, RuleSeverity severity, Dictionary< string, object > args)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (Core.IPropertyInfo propertyInfo, RuleSeverity severity, Dictionary< string, object > args)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, string friendlyName, RuleSeverity severity, Dictionary< string, object > args)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, RuleSeverity severity, bool stopProcessing, Dictionary< string, object > args)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (Core.IPropertyInfo propertyInfo, RuleSeverity severity, bool stopProcessing, Dictionary< string, object > args)
 Creates an instance of RuleArgs. More...
 
 DecoratedRuleArgs (string propertyName, string friendlyName, RuleSeverity severity, bool stopProcessing, Dictionary< string, object > args)
 Creates an instance of RuleArgs. More...
 
override string ToString ()
 Return a string representation of the object using the rule:// URI format. More...
 
- Public Member Functions inherited from Csla.Validation.RuleArgs
 RuleArgs (string propertyName)
 Creates an instance of RuleArgs. More...
 
 RuleArgs (Core.IPropertyInfo propertyInfo)
 Creates an instance of RuleArgs. More...
 
 RuleArgs (string propertyName, string friendlyName)
 Creates an instance of RuleArgs. More...
 
 RuleArgs (string propertyName, RuleSeverity severity)
 Creates an instance of RuleArgs. More...
 
 RuleArgs (Core.IPropertyInfo propertyInfo, RuleSeverity severity)
 Creates an instance of RuleArgs. More...
 
 RuleArgs (string propertyName, string friendlyName, RuleSeverity severity)
 Creates an instance of RuleArgs. More...
 
 RuleArgs (string propertyName, RuleSeverity severity, bool stopProcessing)
 Creates an instance of RuleArgs. More...
 
 RuleArgs (Core.IPropertyInfo propertyInfo, RuleSeverity severity, bool stopProcessing)
 Creates an instance of RuleArgs. More...
 
 RuleArgs (string propertyName, string friendlyName, RuleSeverity severity, bool stopProcessing)
 Creates an instance of RuleArgs. More...
 
override string ToString ()
 Returns a string representation of the object. More...
 

Properties

object this[string key] [getset]
 Gets or sets an argument value for use by the rule method. More...
 
- Properties inherited from Csla.Validation.RuleArgs
string PropertyName [get]
 The name of the property to be validated. More...
 
string PropertyFriendlyName [getset]
 Gets or sets a friendly name for the property, which will be used in place of the property name when creating the broken rule description string. More...
 
string Description [getset]
 Set by the rule handler method to describe the broken rule. More...
 
RuleSeverity Severity [getset]
 Gets or sets the severity of the broken rule. More...
 
bool StopProcessing [getset]
 Gets or sets a value indicating whether this broken rule should stop the processing of subsequent rules for this property. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Csla.Validation.RuleArgs
static string GetPropertyName (RuleArgs e)
 Gets the property name from the RuleArgs object, using the friendly name if one is defined. More...
 

Detailed Description

Object providing extra information to methods that implement business rules.

Definition at line 23 of file DecoratedRuleArgs.cs.

Constructor & Destructor Documentation

◆ DecoratedRuleArgs() [1/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.

Definition at line 33 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [2/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( Core.IPropertyInfo  propertyInfo)

Creates an instance of RuleArgs.

Parameters
propertyInfoThe PropertyInfo for the property to be validated.

Definition at line 43 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [3/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
string  friendlyName 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
friendlyNameA friendly name for the property, which will be used in place of the property name when creating the broken rule description string.

Definition at line 56 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [4/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
RuleSeverity  severity 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
severityInitial default severity for the rule.

The severity parameter defines only the initial default severity value. If the rule changes this value by setting e.Severity, then that new value will become the default for all subsequent rule invocations.

To avoid confusion, it is recommended that the severity constructor parameter only be used for rule methods that do not explicitly set e.Severity.

Definition at line 80 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [5/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( Core.IPropertyInfo  propertyInfo,
RuleSeverity  severity 
)

Creates an instance of RuleArgs.

Parameters
propertyInfoThe PropertyInfo for the property to be validated.
severityInitial default severity for the rule.

The severity parameter defines only the initial default severity value. If the rule changes this value by setting e.Severity, then that new value will become the default for all subsequent rule invocations.

To avoid confusion, it is recommended that the severity constructor parameter only be used for rule methods that do not explicitly set e.Severity.

Definition at line 104 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [6/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
string  friendlyName,
RuleSeverity  severity 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
friendlyNameA friendly name for the property, which will be used in place of the property name when creating the broken rule description string.
severityInitial default severity for the rule.

The severity parameter defines only the initial default severity value. If the rule changes this value by setting e.Severity, then that new value will become the default for all subsequent rule invocations.

To avoid confusion, it is recommended that the severity constructor parameter only be used for rule methods that do not explicitly set e.Severity.

Definition at line 131 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [7/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
RuleSeverity  severity,
bool  stopProcessing 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
severityThe default severity for the rule.
stopProcessingInitial default value for the StopProcessing property.

The severity and stopProcessing parameters define only the initial default values. If the rule changes these values by setting e.Severity or e.StopProcessing, then the new values will become the default for all subsequent rule invocations.

To avoid confusion, It is recommended that the severity and stopProcessing constructor parameters only be used for rule methods that do not explicitly set e.Severity or e.StopProcessing.

Definition at line 159 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [8/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( Core.IPropertyInfo  propertyInfo,
RuleSeverity  severity,
bool  stopProcessing 
)

Creates an instance of RuleArgs.

Parameters
propertyInfoThe PropertyInfo for the property to be validated.
severityThe default severity for the rule.
stopProcessingInitial default value for the StopProcessing property.

The severity and stopProcessing parameters define only the initial default values. If the rule changes these values by setting e.Severity or e.StopProcessing, then the new values will become the default for all subsequent rule invocations.

To avoid confusion, It is recommended that the severity and stopProcessing constructor parameters only be used for rule methods that do not explicitly set e.Severity or e.StopProcessing.

Definition at line 187 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [9/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
string  friendlyName,
RuleSeverity  severity,
bool  stopProcessing 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
friendlyNameA friendly name for the property, which will be used in place of the property name when creating the broken rule description string.
severityThe default severity for the rule.
stopProcessingInitial default value for the StopProcessing property.

The severity and stopProcessing parameters define only the initial default values. If the rule changes these values by setting e.Severity or e.StopProcessing, then the new values will become the default for all subsequent rule invocations.

To avoid confusion, It is recommended that the severity and stopProcessing constructor parameters only be used for rule methods that do not explicitly set e.Severity or e.StopProcessing.

Definition at line 218 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [10/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
Dictionary< string, object >  args 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
argsReference to a Dictionary containing name/value arguments for use by the rule method.

Definition at line 232 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [11/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( Core.IPropertyInfo  propertyInfo,
Dictionary< string, object >  args 
)

Creates an instance of RuleArgs.

Parameters
propertyInfoThe PropertyInfo for the property to be validated.
argsReference to a Dictionary containing name/value arguments for use by the rule method.

Definition at line 244 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [12/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
string  friendlyName,
Dictionary< string, object >  args 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
friendlyNameA friendly name for the property, which will be used in place of the property name when creating the broken rule description string.
argsReference to a Dictionary containing name/value arguments for use by the rule method.

Definition at line 259 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [13/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
RuleSeverity  severity,
Dictionary< string, object >  args 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
severityInitial default severity for the rule.
argsReference to a Dictionary containing name/value arguments for use by the rule method.

The severity parameter defines only the initial default severity value. If the rule changes this value by setting e.Severity, then that new value will become the default for all subsequent rule invocations.

To avoid confusion, it is recommended that the severity constructor parameter only be used for rule methods that do not explicitly set e.Severity.

Definition at line 285 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [14/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( Core.IPropertyInfo  propertyInfo,
RuleSeverity  severity,
Dictionary< string, object >  args 
)

Creates an instance of RuleArgs.

Parameters
propertyInfoThe PropertyInfo for the property to be validated.
severityInitial default severity for the rule.
argsReference to a Dictionary containing name/value arguments for use by the rule method.

The severity parameter defines only the initial default severity value. If the rule changes this value by setting e.Severity, then that new value will become the default for all subsequent rule invocations.

To avoid confusion, it is recommended that the severity constructor parameter only be used for rule methods that do not explicitly set e.Severity.

Definition at line 311 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [15/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
string  friendlyName,
RuleSeverity  severity,
Dictionary< string, object >  args 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
friendlyNameA friendly name for the property, which will be used in place of the property name when creating the broken rule description string.
severityInitial default severity for the rule.
argsReference to a Dictionary containing name/value arguments for use by the rule method.

The severity parameter defines only the initial default severity value. If the rule changes this value by setting e.Severity, then that new value will become the default for all subsequent rule invocations.

To avoid confusion, it is recommended that the severity constructor parameter only be used for rule methods that do not explicitly set e.Severity.

Definition at line 340 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [16/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
RuleSeverity  severity,
bool  stopProcessing,
Dictionary< string, object >  args 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
severityThe default severity for the rule.
stopProcessingInitial default value for the StopProcessing property.
argsReference to a Dictionary containing name/value arguments for use by the rule method.

The severity and stopProcessing parameters define only the initial default values. If the rule changes these values by setting e.Severity or e.StopProcessing, then the new values will become the default for all subsequent rule invocations.

To avoid confusion, It is recommended that the severity and stopProcessing constructor parameters only be used for rule methods that do not explicitly set e.Severity or e.StopProcessing.

Definition at line 370 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [17/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( Core.IPropertyInfo  propertyInfo,
RuleSeverity  severity,
bool  stopProcessing,
Dictionary< string, object >  args 
)

Creates an instance of RuleArgs.

Parameters
propertyInfoThe PropertyInfo for the property to be validated.
severityThe default severity for the rule.
stopProcessingInitial default value for the StopProcessing property.
argsReference to a Dictionary containing name/value arguments for use by the rule method.

The severity and stopProcessing parameters define only the initial default values. If the rule changes these values by setting e.Severity or e.StopProcessing, then the new values will become the default for all subsequent rule invocations.

To avoid confusion, It is recommended that the severity and stopProcessing constructor parameters only be used for rule methods that do not explicitly set e.Severity or e.StopProcessing.

Definition at line 400 of file DecoratedRuleArgs.cs.

◆ DecoratedRuleArgs() [18/18]

Csla.Validation.DecoratedRuleArgs.DecoratedRuleArgs ( string  propertyName,
string  friendlyName,
RuleSeverity  severity,
bool  stopProcessing,
Dictionary< string, object >  args 
)

Creates an instance of RuleArgs.

Parameters
propertyNameThe name of the property to be validated.
friendlyNameA friendly name for the property, which will be used in place of the property name when creating the broken rule description string.
severityThe default severity for the rule.
stopProcessingInitial default value for the StopProcessing property.
argsReference to a Dictionary containing name/value arguments for use by the rule method.

The severity and stopProcessing parameters define only the initial default values. If the rule changes these values by setting e.Severity or e.StopProcessing, then the new values will become the default for all subsequent rule invocations.

To avoid confusion, It is recommended that the severity and stopProcessing constructor parameters only be used for rule methods that do not explicitly set e.Severity or e.StopProcessing.

Definition at line 433 of file DecoratedRuleArgs.cs.

Member Function Documentation

◆ ToString()

override string Csla.Validation.DecoratedRuleArgs.ToString ( )

Return a string representation of the object using the rule:// URI format.

Definition at line 466 of file DecoratedRuleArgs.cs.

Property Documentation

◆ this[string key]

object Csla.Validation.DecoratedRuleArgs.this[string key]
getset

Gets or sets an argument value for use by the rule method.

Parameters
keyThe name under which the value is stored.
Returns

Definition at line 445 of file DecoratedRuleArgs.cs.