CATPlantShipInterfaces Class CATEAPspValidation
All Frameworks Class Hierarchy This Framework Indexes
CATPlantShipInterfaces Class CATEAPspValidation
Usage: you can derive this class.
public class CATEAPspValidation
Constructor and Destructor Index
- o
CATEAPspValidation()
-
- o
~CATEAPspValidation()
-
Method Index
- o
AddViolation(CATListPV**,CATPspCheckViolation*)
- Add the check violation to the violation list.
- o
DeleteCheckViolations(CATListPV*)
- Delete the list of check violations.
- o
GetCheckName(CATUnicodeString&,CATUnicodeString&)
- Implements a function from an interface.
- o
GetClassification(CATUnicodeString&)
- Implements a function from an interface.
- o
GetColumnTitles(CATListValCATUnicodeString&)
- Implements a function from an interface.
- o
GetContextObjectViolationCount(int&)
- Implements a function from an interface.
- o
GetContextObjectViolation(int&,CATPspViolationProduct**,CATListPV**)
- Implements a function from an interface.
- o
GetDescriptions(CATListValCATUnicodeString&,CATListValCATUnicodeString&)
- Get the NLS description for a given key(s)
- o
GetDocColumnTitles(CATListValCATUnicodeString&,CATListValCATUnicodeString&)
- Implements a function from an interface.
- o
GetResource(CATUnicodeString&)
- Get the CATNls resource file associated with this validation type.
- o
GetType(CATUnicodeString&)
- The validation type
- o
GetValidationChecks(CATListValCATUnicodeString&)
- Implements a function from an interface.
- o
GetViolationObjectType(CATUnicodeString&)
- Implements a function from an interface.
- o
IsAFromToCheck()
- Implements a function from an interface.
- o
IsAnIntegrationCheck()
- Implements a function from an interface.
- o
IsMemberAViolation(CATIPspGroup*,CATIUnknownList*,IUnknown*,CATListValCATUnicodeString&,CATListPV**,unsigned int&)
- Implements a function from an interface.
- o
IsObjectAViolation(CATBaseUnknown*,CATListValCATUnicodeString&,CATListPV**,unsigned int&)
- Implements a function from an interface.
- o
LogContextObject(CATBaseUnknown*,unsigned int&)
- Implements a function from an interface.
- o
PrintErrorMessage(unsigned int&,CATUnicodeString&,CATUnicodeString&,CATListValCATUnicodeString&)
- Print the NLS error message for the given key
Constructor and Destructor
o CATEAPspValidation
| public CATEAPspValidation( | ) |
-
o ~CATEAPspValidation
| public virtual ~CATEAPspValidation( | ) |
-
Methods
o AddViolation
| protected virtual AddViolation( | | ioList, |
| | iViolation) |
-
Add the check violation to the violation list. If
the list doesn't exist, it will be created.
- Parameters:
-
- ioList
- The collection of check violations
- iViolation
- The check violation
- Returns:
- HRESULT S_OK if oName is non-blank; else E_FAIL
o DeleteCheckViolations
| protected virtual DeleteCheckViolations( | | iList) |
-
Delete the list of check violations.
- Parameters:
-
- ioList
- The collection of check violations
- Returns:
- HRESULT S_OK
o GetCheckName
| public virtual GetCheckName( | const | iCheck, |
| | oName) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.GetCheckName
o GetClassification
| public virtual GetClassification( | | oClassification) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.GetClassification
o GetColumnTitles
| public virtual GetColumnTitles( | | oTitles) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.GetColumnTitles
o GetContextObjectViolationCount
| public virtual GetContextObjectViolationCount( | | oNumber) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.GetContextObjectViolationCount
o GetContextObjectViolation
| public virtual GetContextObjectViolation( | const | iViolationIndex, |
| | oProduct, |
| | oViolation) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.GetContextObjectViolation
o GetDescriptions
| protected virtual GetDescriptions( | const | iLKeys, |
| | oLDescriptions) |
-
Get the NLS description for a given key(s)
- Parameters:
-
- iLKeys
- Keys within the NLS file
- oLDescriptions
- NLS message associated with iLKeys[i]
- int
- =0 Empty list
=1 Descriptions found
o GetDocColumnTitles
| public virtual GetDocColumnTitles( | | oDocTitles, |
| | oObjectTitles) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.GetDocColumnTitles
o GetResource
| protected virtual GetResource( | | oName) |
-
Get the CATNls resource file associated with this validation type.
- Parameters:
-
- oName
- The resource name
- Returns:
- HRESULT S_OK if oName is non-blank; else E_FAIL
o GetType
| protected virtual GetType( | | oName) |
-
The validation type
- Parameters:
-
- oName
- The key (e.g. CATDVSpec)
- Returns:
- HRESULT S_OK if oName is non-blank; else E_FAIL
o GetValidationChecks
| public virtual GetValidationChecks( | | oChecks) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.GetValidationChecks
o GetViolationObjectType
| public virtual GetViolationObjectType( | | oType) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.GetViolationObjectType
o IsAFromToCheck
| public virtual IsAFromToCheck( | ) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.IsAFromToCheck
o IsAnIntegrationCheck
| public virtual IsAnIntegrationCheck( | ) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.IsAnIntegrationCheck
o IsMemberAViolation
| public virtual IsMemberAViolation( | const | iGroup, |
| const | iMembers, |
| const | iObject, |
| const | iChecks, |
| | oViolation, |
| const | iErrorFile | = 0 ) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.IsMemberAViolation
o IsObjectAViolation
| public virtual IsObjectAViolation( | const | iObject, |
| const | iChecks, |
| | oViolation, |
| const | iErrorFile | = 0 ) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.IsObjectAViolation
o LogContextObject
| public virtual LogContextObject( | const | iObject, |
| const | iErrorFile | =0 ) |
-
Implements a function from an interface.
- See also:
- CATIPspValidation.LogContextObject
o PrintErrorMessage
| protected virtual PrintErrorMessage( | const | iErrorFile, |
| const | iCheck, |
| const | iErrorKey, |
| const | iLParms) |
-
Print the NLS error message for the given key
- Parameters:
-
- iErrorFile
- The file descriptor to the opened error file.
- iCheck
- The validation check (e.g. Spec01)
- iErrorKey
- Key within the NLS file
- iLParms
- Values to parameter defined by /pn where n>=1 (eg. /p1 is replaced
by iLParms[1] in the message).
- HRESULT
- S_OK if error printed; otherwise E_FAIL;
This object is included in the file: CATEAPspValidation.h
If needed, your Imakefile.mk should include the module: CATPspItfCPP
Copyright © 2003, Dassault Systèmes. All rights reserved.