KnowledgeInterfaces Interface 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 Knowledge check.
Role: This interface is implemented on Knowledge Advisor checks.
This interface is mono 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(char*,char*)
- Sets the warning message with NLS name deduced from catalog.
- o
SetWarningMessage(CATUnicodeString&)
- Sets the warning message.
Methods
o GetResultParameter
| public virtual GetResultParameter( | ) |
-
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 GetSeverityParameter( | ) |
-
Returns the severity parameter.
- Returns:
- a CATICkeParm valuated with an integer value.
Legal values:
0 if the check is silent: no message is displayed.
1 if the check displays an information message.
2 if the check displays a warning message.
o GetWarningMessage
| public virtual GetWarningMessage( | ) |
-
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 GetWarningMessageParameter( | ) |
-
Returns the check warning message parameter.
- Returns:
- a CATICkeParm: the string parameter which value is the warning message.
o SetSeverity
| public virtual SetSeverity( | const | iSeverity) |
-
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.
- Returns:
- classic HRESULT
o SetWarningMessage
| public virtual SetWarningMessage( | const | iCatalogName, |
| const | iMsgKey) |
-
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.
- Returns:
- classic HRESULT
o SetWarningMessage
| public virtual SetWarningMessage( | const | iMessage) |
-
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.
- Returns:
- classic HRESULT
This object is included in the file: CATICkeCheck.h
If needed, your Imakefile.mk should include the module: KnowledgeItf
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.