Csla.Rules.RuleUri Class Reference

Parses a rule:// URI to provide easy access to the parts of the URI. More...

Public Member Functions
	RuleUri (string ruleString)
	Creates an instance of the object by parsing the provided rule:// URI.
	RuleUri (Uri uri)
	Creates an instance of the type.
	RuleUri (IBusinessRuleBase rule, Core.IPropertyInfo? property)
	Creates an instance of the type.
	RuleUri (string typeName, string propertyName)
	Creates an instance of the type.
override string	ToString ()
	Gets a string representation of the rule URI.
void	AddQueryParameter (string key, string value)
	Adds a query parameter to the URI.

Static Public Member Functions
static RuleUri	Parse (string ruleString)
	Parses a rule:// URI.

Properties
string	RuleTypeName [get]
	Gets the name of the type containing the rule method.
string	PropertyName [get]
	Gets the name of the property with which the rule is associated.
Dictionary< string, string >??	Arguments [get]
	Gets a Dictionary containing the name/value arguments provided to the rule method.

Detailed Description

Parses a rule:// URI to provide easy access to the parts of the URI.

Constructor & Destructor Documentation

RuleUri() [1/4]

Csla.Rules.RuleUri.RuleUri ( string ruleString )

inline

Creates an instance of the object by parsing the provided rule:// URI.

Parameters

ruleString

The rule:// URI.

Exceptions

ArgumentNullException	ruleString is null.
UriFormatException	ruleString is not a valid Uri format.

RuleUri() [2/4]

Csla.Rules.RuleUri.RuleUri ( Uri uri )

inline

Creates an instance of the type.

Parameters

uri	The rule:// URI.

Exceptions

ArgumentNullException	uri is null.
ArgumentException	uri scheme is not 'rule'.

RuleUri() [3/4]

Csla.Rules.RuleUri.RuleUri ( IBusinessRuleBase rule, Core.IPropertyInfo? property )

inline

Creates an instance of the type.

Parameters

rule	Rule object.
property	Property to which rule applies.

Exceptions

ArgumentNullException

rule is null.

RuleUri() [4/4]

Csla.Rules.RuleUri.RuleUri ( string typeName, string propertyName )

inline

Creates an instance of the type.

Parameters

typeName	Name of the rule type.
propertyName	Name of the business object property or the string literal "null".

Exceptions

ArgumentException

typeName or propertyName is null, string.Empty or only consists of white spaces.

Member Function Documentation

AddQueryParameter()

void Csla.Rules.RuleUri.AddQueryParameter ( string key, string value )

inline

Adds a query parameter to the URI.

Parameters

key	Key for the parameter.
value	Value of the parameter.

Parse()

RuleUri Csla.Rules.RuleUri.Parse ( string ruleString )

inlinestatic

Parses a rule:// URI.

Parameters

ruleString

Text representation of a rule:// URI.

Returns

A populated RuleDescription object.

Exceptions

ArgumentException

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

ToString()

override string Csla.Rules.RuleUri.ToString ( )

inline

Gets a string representation of the rule URI.

Property Documentation

Arguments

Dictionary<string, string>?? Csla.Rules.RuleUri.Arguments

get

Gets a Dictionary containing the name/value arguments provided to the rule method.

PropertyName

string Csla.Rules.RuleUri.PropertyName

get

Gets the name of the property with which the rule is associated.

RuleTypeName

string Csla.Rules.RuleUri.RuleTypeName

get

Gets the name of the type containing the rule method.

---

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

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