Package com.aquima.interactions.rule

Interface IBusinessRule

All Superinterfaces:
Serializable
All Known Subinterfaces:
IConstraint, IInferenceRule, IValidationRule
All Known Implementing Classes:
BusinessRule, ConstraintDefault, ConstraintRule, ConversionRule, CsvDataRule, DecisionTableRule, DefaultExpression, DefaultValue, ExpressionValidator, FailedConstraint, FailedRule, FailedValidation, ReverseRelationRule, ValidationRuleBase, ValueValidator, XmlConstraint, XmlConstraint
public interface IBusinessRule extends Serializable
A base interface for constraints, validations and inference rules. It possibly highly interactive with expressions and profile values. The source scope objects are an integral part of the business rules. They deliver the rule engine with knowledge about dependencies and scope validation.
Since:
5.0
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    This method returns the unique name for the business rule.
    String[]
    getRuleGroupNames()
    This method returns an array containing the names of the rule groups this rule belongs to.
    String[]
    getSourceScopeObjects()
    This method should return a list of objects that are required to be in scope in order for the rule to operate successfully.
    String[]
    getTargetAttributes()
    This method should return an array of attribute names that the rule applies on.

  • Method Details

    • getName

      String getName()
      This method returns the unique name for the business rule.
      Returns:
      the unique name for the business rule.

    • getSourceScopeObjects

      String[] getSourceScopeObjects()
      This method should return a list of objects that are required to be in scope in order for the rule to operate successfully. There are three kinds of object references that a rule may require to be in scope:
      • Type reference
        A type reference is declared by an entity name followed by an asterisk (*), for example Product*. Type references can be used when the rule uses information about the existence of instances of that type, for example when a rule contains COUNT( ALL Product ).
      • Named reference
        A named reference is declared by an entity name followed by square brackets containing the name of the instance that is referred. Named references usually refer to static instances that are declared in the metamodel, for example Product[Unica]
      • Direct reference
        A direct reference is declared by the entity name of the object that is referred to. A direct reference is a reference to an active object of the specified type. When a rule declares a direct reference, the object referred to must be of the same type of the object that the rule applies on. A business rule will be evaluated within its own context, and may thus not depend on active instances from other contexts like the current page. Only the object that triggered the rule will be available in the context. For example a rule calculating the age of a person by using the person.birth_date will declare a direct reference Person indicating that it depends on an instance of Person to be active.
      Returns:
      An array which is never null but can be zero-length.

    • getTargetAttributes

      String[] getTargetAttributes()
      This method should return an array of attribute names that the rule applies on. When this method returns multiple attribute names, all attributes in the array should belong to the same entity type.
      Returns:
      An array which is never null or zero-length.

    • getRuleGroupNames

      String[] getRuleGroupNames()
      This method returns an array containing the names of the rule groups this rule belongs to. If the rule does not belong to a specific rule group, the returned value may either be null or an empty array. Rules that belong to a rule group will only be evaluated when one (or more) of the rule groups are active. Rule groups are sometimes referred to as rule clusters.
      Returns:
      an array containing the names of the rule groups this rule belongs to.