Rule Data Type

Rule - business logic for the product selection. A Rule contains the business-logic for the product selection. The selection result can be influenced by one or more {see LimitationRule}s. (The demo web- frontend supports only one LimitationRule an is on a limitation of the frontend).

Available Since
2012-05-22
Properties
name data type constraints description
id string  
name string   get the name for the Rule
description string   get the description of the rule
ruleType string   get the name of the plugin
step number required get the step in which the rule should be executed
numResults number required get the maximum number of results the rule should return
dateCreated number  
dateModified number  
fillUpRule boolean required get if this rule should act as a fillup rule. Fillup rules will try to fetch the remaining number results to reach the maximum number of results specified in the RuleSet. If a rule is marked as fillup getNumResults will be ignored.
limitationCollection array of Limitation   get the limitations attached to this rule.

Example

{
  "id" : "...",
  "name" : "...",
  "description" : "...",
  "ruleType" : "...",
  "step" : 12345,
  "numResults" : 12345,
  "dateCreated" : 12345,
  "dateModified" : 12345,
  "fillUpRule" : true,
  "limitationCollection" : [ {
    "field" : "...",
    "description" : "...",
    "entity" : "...",
    "dateModified" : 12345,
    "operator" : "NOT_CONTAINS",
    "filterValue" : "...",
    "dateCreated" : 12345,
    "id" : "...",
    "name" : "..."
  }, {
    "field" : "...",
    "description" : "...",
    "entity" : "...",
    "dateModified" : 12345,
    "operator" : "ENDS_WITH",
    "filterValue" : "...",
    "dateCreated" : 12345,
    "id" : "...",
    "name" : "..."
  } ]
}