All Frameworks Class Hierarchy This Framework Previous Indexes
KnowHow Interface CATIRuleSet
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---KnowHow.CATIGenericRuleBaseComponent
|
+---CATIRuleSet
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIRuleSet
Interface dedicated to elementary operations on a rule set.
Role Rule sets are used for the hierarchical organization of expert rules
and expert checks. Under a rule base, one creates rule sets, and in rule sets,
other rule sets, and so on ... The checks and rules can then be grouped in
rule sets.
- See also:
- CATIRuleBase, CATIRule, CATICheck
Method Index
- o
AddRuleBaseComponent(CATIRuleBaseComponent_var&)
- Adds a rulebase component under this rule set, if a rulebase component with
the same name does not already exist.
- o
AddRuleSet(CATIRuleSet_var&)
- Adds a ruleset under this rule set, if a ruleset with
the same name does not already exist.
- o
CreateCheck(CATICheck_var&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIRuleBaseComponent::RuleBaseComponentLanguage)
- Creates a check under the current ruleset.
- o
CreateRule(CATIRule_var&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIRuleBaseComponent::RuleBaseComponentLanguage)
- Creates a rule under the current ruleset.
- o
CreateRuleset(CATIRuleSet_var&,CATUnicodeString&)
- Creates a rule set under the current ruleset.
- o
FindAnyRuleBaseComponent(CATListValCATIRuleBaseComponent_var&,boolean)
- Returns all the rulebase components (rules and checks) under this rule set.
- o
FindAnyRuleSet(CATListValCATIRuleSet_var&,boolean)
- Returns all the rulesets under this rule set.
- o
FindRuleBaseComponent(CATUnicodeString,boolean)
- Returns the first rulebase component (rule or check), under this rule set, with the according name.
- o
FindRuleSet(CATUnicodeString,boolean)
- Returns the first ruleset under this rule set, with the according name.
- o
GetAllGenericRuleBaseComponents(CATListValCATIGenericRuleBaseComponent_var&)
- Returns all generic rule base components under this rule set, recursively.
- o
GetDirectGenericRuleBaseComponents(CATListValCATIGenericRuleBaseComponent_var&)
- Returns all generic rule base components right under this rule set.
- o
ImportRuleBaseComponent(CATIRuleBaseComponent_var&,conflictingImportFunctionPtr)
- Import one rulebase component (check or rule) into the current ruleset.
- o
ImportRuleSet(CATIRuleSet_var&,conflictingImportFunctionPtr)
- Imports the contents of a ruleset into the current one.
- o
RemoveRuleBaseComponent(CATIRuleBaseComponent_var&)
- Removes a rule base component under this rule set.
- o
RemoveRuleSet(CATIRuleSet_var&)
- Removes a ruleset under this rule set.
- o
Status()
- Returns the status of the ruleset.
Methods
o AddRuleBaseComponent
-
Adds a rulebase component under this rule set, if a rulebase component with
the same name does not already exist.
- Parameters:
-
- spRuleBaseComponent
- a rulebase component.
- Returns:
- the component under the rule set (the previous one if one with same name already exists)
o AddRuleSet
public virtual CATIRuleSet_var AddRuleSet( | const CATIRuleSet_var& | spRuleSet)=0 |
-
Adds a ruleset under this rule set, if a ruleset with
the same name does not already exist.
- Parameters:
-
- spRuleSet
- a rulebase component.
- Returns:
- the component under the rule set (the previous one if one with same name already exists)
o CreateCheck
-
Creates a check under the current ruleset.
- Parameters:
-
- oCreatedCheck
- The created check.
- iName
- Name of the check.
- iVariables
- Variables of the check.
- iBody
- Body of the check.
- iLanguage
- Language of the check.
- Returns:
- S_OK or E_FAIL
o CreateRule
-
Creates a rule under the current ruleset.
- Parameters:
-
- oCreatedRule
- The created rule.
- iName
- Name of the rule.
- iVariables
- Variables of the rule.
- iBody
- Body of the rule.
- iLanguage
- Language of the rule.
- Returns:
- S_OK or E_FAIL
o CreateRuleset
-
Creates a rule set under the current ruleset.
- Parameters:
-
- oCreatedRuleSet
- The created ruleset.
- iName
- Name of the rule set.
- Returns:
- S_OK or E_FAIL
o FindAnyRuleBaseComponent
public virtual void FindAnyRuleBaseComponent( | CATListValCATIRuleBaseComponent_var& | iolListToBeFilled, |
| boolean | iRecursive | = FALSE)=0 |
-
Returns all the rulebase components (rules and checks) under this rule set.
- Parameters:
-
- iolListToBeFilled
- list filled with the found rulebase components.
- iRecursive
- TRUE for a recursive search, FALSE to a search limited at the current ruleset.
o FindAnyRuleSet
public virtual void FindAnyRuleSet( | CATListValCATIRuleSet_var& | iolListToBeFilled, |
| boolean | iRecursive | = FALSE)=0 |
-
Returns all the rulesets under this rule set.
- Parameters:
-
- iolListToBeFilled
- list filled with the found rulesets.
- iRecursive
- TRUE for a recursive search, FALSE to a search limited at the current ruleset.
o FindRuleBaseComponent
-
Returns the first rulebase component (rule or check), under this rule set, with the according name.
- Parameters:
-
- iName
- name of the component.
- iRecursive
- TRUE for a recursive search, FALSE to a search limited at the current ruleset.
- Returns:
- the found component or NULL_var if not found
o FindRuleSet
-
Returns the first ruleset under this rule set, with the according name.
- Parameters:
-
- iName
- name of the ruleset.
- iRecursive
- TRUE for a recursive search, FALSE to a search limited at the current ruleset.
- Returns:
- the found component or NULL_var if not found
o GetAllGenericRuleBaseComponents
public virtual void GetAllGenericRuleBaseComponents( | CATListValCATIGenericRuleBaseComponent_var& | iolListToBeFilled)=0 |
-
Returns all generic rule base components under this rule set, recursively.
- Parameters:
-
- iolListToBeFilled
- List filled with the components.
o GetDirectGenericRuleBaseComponents
public virtual void GetDirectGenericRuleBaseComponents( | CATListValCATIGenericRuleBaseComponent_var& | iolListToBeFilled)=0 |
-
Returns all generic rule base components right under this rule set.
- Parameters:
-
- iolListToBeFilled
- List filled with the components.
o ImportRuleBaseComponent
-
Import one rulebase component (check or rule) into the current ruleset.
- Parameters:
-
- iRuleBaseComponentToImport
- A rulebase component (check or rule) to import.
- iFct
- A function triggered on conflicting objects.
- Returns:
- S_OK or E_FAIL
o ImportRuleSet
-
Imports the contents of a ruleset into the current one.
- Parameters:
-
- iRuleSetToImport
- A ruleset to import the contents from.
- iFct
- A function triggered on conflicting objects.
- Returns:
- S_OK or E_FAIL
o RemoveRuleBaseComponent
public virtual void RemoveRuleBaseComponent( | const CATIRuleBaseComponent_var& | spRuleBaseComponent)=0 |
-
Removes a rule base component under this rule set.
- Parameters:
-
- spRuleBaseComponent
- a rule base component.
o RemoveRuleSet
public virtual void RemoveRuleSet( | const CATIRuleSet_var& | spRuleSet)=0 |
-
Removes a ruleset under this rule set.
- Parameters:
-
- spRuleSet
- a rule base component.
o Status
public virtual CATExpertReportEnum::ValidityTypeEnum Status( | )=0 |
-
Returns the status of the ruleset.
For instance, if all objets under the ruleset are green, then the ruleset is green.
- Returns:
- status of the ruleset.
This object is included in the file: CATIRuleSet.h
If needed, your Imakefile.mk should include the module: CATKWERule