All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowHow Interface CATIRuleBaseFactory

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIRuleBaseFactory
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIRuleBaseFactory

Interface dedicated to describe the factory for creation of rulebases, rulesets, rules and checks.
Role this interface describes how to create plain rulebases, linked rulebases (the rulebase is in another document, but it is seen as if it were in the current document), rulesets, rules checks and reports.
The created rulesets, rules or checks have to be added to the desired ruleset through the appropriate Add service of CATIRuleSet .


Method Index


o CreateBase(CATUnicodeString&,CATISpecObject_var&)
Creates a rule base.
o CreateCheck(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIRuleBaseComponent::RuleBaseComponentLanguage)
Creates a check in a container.
o CreateLinkedBase(CATUnicodeString&,CATISpecObject_var&)
Creates a linked rule base in a container.
o CreateLinkedRuleBase(CATUnicodeString&,CATIRuleBase_var&,CATISpecObject_var&)
Creates a linked rule base in a container.
o CreateReport(CATUnicodeString&,CATICheckReport_var&)
Creates a report object for a check report.
o CreateRule(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIRuleBaseComponent::RuleBaseComponentLanguage)
Creates a rule in a container.
o CreateRuleset(CATUnicodeString&)
Creates a rule set in a container.

Methods


o CreateBase
public virtual CATIRuleBase_var CreateBase( const CATUnicodeString& iName,
const CATISpecObject_var& spOwner= NULL_var )=0
Creates a rule base.
Parameters:
iName
Name of the rulebase.
spOwner
Name of a feature under which the base is to be added. Default values: the rule base is added in the container.
Returns:
the created rule base.
o CreateCheck
public virtual CATICheck_var CreateCheck( const CATUnicodeString& iName,
const CATUnicodeString& iVariables,
const CATUnicodeString& iBody,
CATIRuleBaseComponent::RuleBaseComponentLanguage iLanguage= CATIRuleBaseComponent::KWELanguage)=0
Creates a check in a container.
Parameters:
iName
Name of the check.
iVariables
Variables of the check.
iBody
Body of the check.
iLanguage
Language of the check.
Returns:
the created check.
o CreateLinkedBase
public virtual CATIRuleBase_var CreateLinkedBase( const CATUnicodeString& iName,
const CATISpecObject_var& spOwner= NULL_var )=0
Creates a linked rule base in a container.
Parameters:
iName
Name of the rulebase.
spOwner
Name of a feature under which the base is to be added. Default values: the rule base is added in the container.
Returns:
the created rule base.
o CreateLinkedRuleBase
public virtual CATIRuleBase_var CreateLinkedRuleBase( const CATUnicodeString& iName,
const CATIRuleBase_var& iRuleBase,
const CATISpecObject_var& spOwner= NULL_var )=0
Creates a linked rule base in a container.
Parameters:
iName
Name of the rulebase.
iRuleBase
Rule Base linked.
spOwner
Name of a feature under which the base is to be added. Default values: the rule base is added in the container.
Returns:
the created a linked rule base.
o CreateReport
public virtual CATIReportObject_var CreateReport( const CATUnicodeString& iName,
CATICheckReport_var& spCheckReport) = 0
Creates a report object for a check report.
Parameters:
iName
Name of the report.
spCheckReport
Check report on which the report is to be done.
Returns:
a report object.
o CreateRule
public virtual CATIRule_var CreateRule( const CATUnicodeString& iName,
const CATUnicodeString& iVariables,
const CATUnicodeString& iBody,
CATIRuleBaseComponent::RuleBaseComponentLanguage iLanguage= CATIRuleBaseComponent::KWELanguage)=0
Creates a rule in a container.
Parameters:
iName
Name of the rule.
iVariables
Variables of the rule.
iBody
Body of the rule.
iLanguage
Language of the rule.
Returns:
the created rule.
o CreateRuleset
public virtual CATIRuleSet_var CreateRuleset( const CATUnicodeString& iName)=0
Creates a rule set in a container.
Parameters:
iName
Name of the rule set.
Returns:
the created rule set.

This object is included in the file: CATIRuleBaseFactory.h
If needed, your Imakefile.mk should include the module: CATKWERule

Copyright © 2003, Dassault Systèmes. All rights reserved.