All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowledgeInterfaces Interface CATICkeCheck

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

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


interface CATICkeCheck

Interface representing the result parameter of a check.
Role: This interface is implemented on Knowledge Advisor checks.


Method Index


o GetResultParameter()
Returns the check result parameter.
o GetSeverityParameter()
Returns the severity parameter.
o GetWarningMessage()
Returns the check warning message.
o GetWarningMessageParameter()
Returns the check warning message parameter.
o SetSeverity(int&)
Sets the severity.
o SetWarningMessage(CATUnicodeString&)
Sets the warning message.
o SetWarningMessage(char*,char*)
Sets the warning message with NLS name deduced from catalog.

Methods


o GetResultParameter
public virtual CATICkeParm_var GetResultParameter()const = 0
Returns the check result parameter.
Returns:
a CATICkeParm of boolean type.
Legal values: True if the check is verified. False if the check is KO.
o GetSeverityParameter
public virtual CATICkeParm_var GetSeverityParameter()const = 0
Returns the severity parameter.
Returns:
a CATICkeParm valuated with an integer value.
Legal values: 0 if the check is silent: nos message are displayed. 1 if the check displays an information message. 2 if the check displays a warning message.
o GetWarningMessage
public virtual CATUnicodeString GetWarningMessage()const = 0
Returns the check warning message.
Returns:
a CATUnicodeString: the warning message associated to the check when it fails. This warning message is displayed if the check has a severity = 2.
o GetWarningMessageParameter
public virtual CATICkeParm_var GetWarningMessageParameter()const = 0
Returns the check warning message parameter.
Returns:
a CATICkeParm: the string parameter which value is the warning message.
o SetSeverity
public virtual void SetSeverity( const int& iSeverity) = 0
Sets the severity.
Parameters:
iSeverity
The severity is defined with an integer value:
Legal values: 0 if the check is silent: no message are displayed. 1 if the check displays an information message. 2 if the check displays a warning message.
o SetWarningMessage
public virtual void SetWarningMessage( const CATUnicodeString& iMessage) = 0
Sets the warning message.
Parameters:
iMessage
the string valuating the warning message of the check. This warning message is displayed if the check has a severity = 2.
o SetWarningMessage
public virtual void SetWarningMessage( const char* iCatalogName,
const char* iMsgKey) = 0
Sets the warning message with NLS name deduced from catalog. Note that check should be read only !.
Parameters:
iCatalogName
the catalog where to find the NLS message.
iMsgKey
the key in the catalog.

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

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