Extension Methods

• Evaluate(..)
  Returns: System.Boolean - Returns a Boolean value indicating the result of the rule evaluation: true if the evaluation succeeded; otherwise, false.

  Evaluates a rule from the specified ruleset against the given source object. This extension method serves as a shortcut for calling the Evaluator<TSource>.Evaluate(..) method. Use Evaluator<TSource> class directly when executing multiple evaluations with the same ruleset, as the evaluator compiles rules once per instantiation.

  Type Parameters

  • TSource - Specifies the underlying source type of the object against which the rules will be evaluated.

  Parameters

  • this source (TSource) - Specifies the object to be evaluated. This object serves as the data source for the rule.
  • getRule (CodeEffects.Rule.Common.Models.GetRuleDelegate) - Specifies a delegate to a method used for retrieving external rules referenced by other rules. If this parameter is null, the evaluator attempts to locate any referenced rules within the ruleset itself. If no referenced rules are found, an exception is thrown.
  • rulesetXml (System.String) - The Rule XML document as a string.
  • ruleIndex (System.Int32) - Specifies the index of the rule to be executed. If the ruleset contains multiple rules, you can evaluate a specific rule by providing its zero-based index. Do not confuse this with external rules referenced within other rules. The specified rule must exist as a top-level rule within the ruleset; otherwise, an exception will be thrown.

• Evaluate(..)
  Returns: System.Boolean - Returns a Boolean value indicating the result of the rule evaluation: true if the evaluation succeeded; otherwise, false.

  Evaluates a rule from the specified ruleset against the given source object. This extension method serves as a shortcut for calling the Evaluator<TSource>.Evaluate(..) method. Use Evaluator<TSource> class directly when executing multiple evaluations with the same ruleset, as the evaluator compiles rules once per instantiation.

  Type Parameters

  • TSource - Specifies the underlying source type of the object against which the rules will be evaluated.

  Parameters

  • this source (TSource) - Specifies the object to be evaluated. This object serves as the data source for the rule.
  • rulesetXml (System.String) - The Rule XML document as a string.
  • ruleId (System.String) - Specifies an optional ID of the rule to be evaluated. If the ruleset contains multiple rules, you can evaluate a specific rule by providing its ID. Do not confuse this with external rules referenced within other rules. The specified rule must exist as a top-level rule within the ruleset; otherwise, an exception will be thrown.
  • getRule (CodeEffects.Rule.Common.Models.GetRuleDelegate) - Specifies a delegate to a method used for retrieving external rules referenced by other rules. If this parameter is null, the evaluator attempts to locate any referenced rules within the ruleset itself. If no referenced rules are found, an exception is thrown.

• Filter(..)
  Returns: System.Collections.IEnumerable - Returns a new System.Collections.Generic.IEnumerable<T> collection containing all source objects that satisfied the rule evaluation.

  Filters a collection of source objects by applying a business rule. The specified ruleset Xml is loaded into the Evaluator class, where its rules are compiled and stored in memory. The evaluator then applies either the first rule in the ruleset or the rule identified by the specified rule ID to each object in the collection. Source objects that satisfy the rule are returned as a new collection of type System.Collections.IEnumerable.

  Parameters

  • this source (System.Collections.IEnumerable) - Specifies an enumerable collection to be filtered.
  • type (System.Collections.IEnumerable) - Specifies the underlying source type of the enumerable collection.
  • rulesetXml (System.String) - The Rule XML document as a string to be evaluated against source objects.
  • ruleId (System.String) - Specifies an optional ID of the rule to be evaluated. If the ruleset contains multiple rules, you can evaluate a specific rule by providing its ID. Do not confuse this with external rules referenced within other rules. The specified rule must exist as a top-level rule within the ruleset; otherwise, an exception will be thrown.
  • getRule (CodeEffects.Rule.Common.Models.GetRuleDelegate) - Specifies a delegate to a method used for retrieving external rules referenced by other rules. If this parameter is null, the evaluator attempts to locate any referenced rules within the ruleset itself. If no referenced rules are found, an exception is thrown.

• Filter(..)
  Returns: System.Collections.IQueryable - Returns an expression tree of type System.Linq.IQueryable<T> for deferred or immediate evaluation. Immediate evaluation is performed by the underlying LINQ provider.

  Filters a collection of source objects by applying a business rule. The specified ruleset Xml is loaded into the Evaluator, where its rules are compiled into expression trees. This method does not perform immediate evaluation; instead, it returns an expression tree that can be further modified. During execution, the expression tree is translated into a set of backend commands supported by the underlying LINQ provider. For example, when using LINQ to SQL, the expression tree is translated into corresponding SQL commands.

  Parameters

  • this source (System.Collections.IQueryable) - Specifies a queriable collection to be filtered.
  • type (System.Collections.IEnumerable) - Specifies the underlying source type of the queriable collection.
  • rulesetXml (System.String) - The Rule XML document as a string to be evaluated against source objects.
  • parameters (CodeEffects.Rule.Common.Models.EvaluationParameters) - The evaluation parameters.

• Filter(..)
  Returns: System.Collections.IQueryable - Returns an expression tree of type System.Linq.IQueryable<T> for deferred or immediate evaluation. Immediate evaluation is performed by the underlying LINQ provider.

  Filters a collection of source objects by applying a business rule. The specified ruleset Xml is loaded into the Evaluator, where its rules are compiled into expression trees. This method does not perform immediate evaluation; instead, it returns an expression tree that can be further modified. During execution, the expression tree is translated into a set of backend commands supported by the underlying LINQ provider. For example, when using LINQ to SQL, the expression tree is translated into corresponding SQL commands.

  Parameters

  • this source (System.Collections.IQueryable) - Specifies a queriable collection to be filtered.
  • type (System.Collections.IEnumerable) - Specifies the underlying source type of the queriable collection.
  • rulesetXml (System.String) - The Rule XML document as a string to be evaluated against source objects.
  • ruleId (System.String) - Specifies an optional ID of the rule to be evaluated. If the ruleset contains multiple rules, you can evaluate a specific rule by providing its ID. Do not confuse this with external rules referenced within other rules. The specified rule must exist as a top-level rule within the ruleset; otherwise, an exception will be thrown.
  • getRule (CodeEffects.Rule.Common.Models.GetRuleDelegate) - Specifies a delegate to a method used for retrieving external rules referenced by other rules. If this parameter is null, the evaluator attempts to locate any referenced rules within the ruleset itself. If no referenced rules are found, an exception is thrown.

• Filter<TSource>(..)
  Returns: System.Collections.IEnumerable<TSource> - Returns a new System.Collections.Generic.IEnumerable<TSource> collection containing all source objects that satisfied the rule evaluation.

  Filters a collection of source objects by applying a business rule. The specified ruleset Xml is loaded into the Evaluator, where its rules are compiled and stored in memory. The evaluator then applies either the first rule in the ruleset or the rule identified by the specified rule ID to each object in the collection. Source objects that satisfy the rule are returned as a new collection of type System.Collections.IEnumerable<TSource>.

  Type Parameters

  • TSource - An underlying source type of a generic enumerable collection.

  Parameters

  • source (System.Collections.IEnumerable<TSource>) - Specifies an enumerable collection to be filtered.
  • rulesetXml (System.String) - The Rule XML document as a string to be evaluated against source objects.
  • ruleIndex (System.Int32) - Specifies the index of the rule to be executed. If the ruleset contains multiple rules, you can evaluate a specific rule by providing its zero-based index. Do not confuse this with external rules referenced within other rules. The specified rule must exist as a top-level rule within the ruleset; otherwise, an exception will be thrown.
  • getRule (CodeEffects.Rule.Common.Models.GetRuleDelegate) - Specifies a delegate to a method used for retrieving external rules referenced by other rules. If this parameter is null, the evaluator attempts to locate any referenced rules within the ruleset itself. If no referenced rules are found, an exception is thrown.

• Filter<TSource>(..)
  Returns: System.Collections.IEnumerable<TSource> - Returns a new System.Collections.Generic.IEnumerable<TSource> collection containing all source objects that satisfied the rule evaluation.

  Filters a collection of source objects by applying a business rule. The specified ruleset Xml is loaded into the Evaluator, where its rules are compiled and stored in memory. The evaluator then applies either the first rule in the ruleset or the rule identified by the specified rule ID to each object in the collection. Source objects that satisfy the rule are returned as a new collection of type System.Collections.IEnumerable<TSource>.

  Type Parameters

  • TSource - An underlying source type of a generic enumerable collection.

  Parameters

  • source (System.Collections.IEnumerable<TSource>) - Specifies an enumerable collection to be filtered.
  • rulesetXml (System.String) - The Rule XML document as a string to be evaluated against source objects.
  • ruleId (System.String) - Specifies an optional ID of the rule to be evaluated. If the ruleset contains multiple rules, you can evaluate a specific rule by providing its ID. Do not confuse this with external rules referenced within other rules. The specified rule must exist as a top-level rule within the ruleset; otherwise, an exception will be thrown.
  • getRule (CodeEffects.Rule.Common.Models.GetRuleDelegate) - Specifies a delegate to a method used for retrieving external rules referenced by other rules. If this parameter is null, the evaluator attempts to locate any referenced rules within the ruleset itself. If no referenced rules are found, an exception is thrown.

• Filter<TSource>(..)
  Returns: System.Linq.IQueryable<TSource> - Returns an expression tree of type System.Linq.IQueryable<TSource> for deferred or immediate evaluation. Immediate evaluation is performed by the underlying LINQ provider.

  Filters a collection of source objects by applying a business rule. The specified ruleset Xml is loaded into the Evaluator, where its rules are compiled into expression trees. This method does not perform immediate evaluation; instead, it returns an expression tree that can be further modified. During execution, the expression tree is translated into a set of backend commands supported by the underlying LINQ provider. For example, when using LINQ to SQL, the expression tree is translated into corresponding SQL commands.

  Type Parameters

  • TSource - An underlying source type of a generic enumerable collection

  Parameters

  • source (System.Linq.IQueryable<TSource>) - Specifies a queryable collection of type System.Linq.IQueryable<TSource> to be filtered.
  • rulesetXml (System.String) - The Rule XML document as a string to be evaluated against source objects.
  • parameters (CodeEffects.Rule.Common.Models.EvaluationParameters) - The evaluation parameters.

• Filter<TSource>(..)
  Returns: System.Linq.IQueryable<TSource> - Returns an expression tree of type System.Linq.IQueryable<TSource> for deferred or immediate evaluation. Immediate evaluation is performed by the underlying LINQ provider.

  Filters a collection of source objects by applying a business rule. The specified ruleset Xml is loaded into the Evaluator, where its rules are compiled into expression trees. This method does not perform immediate evaluation; instead, it returns an expression tree that can be further modified. During execution, the expression tree is translated into a set of backend commands supported by the underlying LINQ provider. For example, when using LINQ to SQL, the expression tree is translated into corresponding SQL commands.

  Type Parameters

  • TSource - An underlying source type of a generic enumerable collection

  Parameters

  • source (System.Linq.IQueryable<TSource>) - Specifies a queryable collection of type System.Linq.IQueryable<TSource> to be filtered.
  • rulesetXml (System.String) - The Rule XML document as a string to be evaluated against source objects.
  • ruleId (System.String) - Specifies an optional ID of the rule to be evaluated. If the ruleset contains multiple rules, you can evaluate a specific rule by providing its ID. Do not confuse this with external rules referenced within other rules. The specified rule must exist as a top-level rule within the ruleset; otherwise, an exception will be thrown.
  • getRule (CodeEffects.Rule.Common.Models.GetRuleDelegate) - Specifies a delegate to a method used for retrieving external rules referenced by other rules. If this parameter is null, the evaluator attempts to locate any referenced rules within the ruleset itself. If no referenced rules are found, an exception is thrown.