All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATPlantShipInterfaces Class CATEAPspValidation

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 GetContextObjectViolation(int&,CATPspViolationProduct**,CATListPV**)
Implements a function from an interface.
o GetContextObjectViolationCount(int&)
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 HRESULT AddViolation(CATListPV** ioList,
CATPspCheckViolation* 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 HRESULT DeleteCheckViolations(CATListPV* iList)
Delete the list of check violations.
Parameters:
ioList
The collection of check violations
Returns:
HRESULT S_OK
o GetCheckName
public virtual HRESULT GetCheckName( const CATUnicodeString& iCheck,
CATUnicodeString& oName)
Implements a function from an interface.
See also:
CATIPspValidation.GetCheckName
o GetClassification
public virtual HRESULT GetClassification(CATUnicodeString& oClassification)
Implements a function from an interface.
See also:
CATIPspValidation.GetClassification
o GetColumnTitles
public virtual HRESULT GetColumnTitles(CATListValCATUnicodeString& oTitles)
Implements a function from an interface.
See also:
CATIPspValidation.GetColumnTitles
o GetContextObjectViolation
public virtual HRESULT GetContextObjectViolation( const int& iViolationIndex,
CATPspViolationProduct** oProduct,
CATListPV** oViolation)
Implements a function from an interface.
See also:
CATIPspValidation.GetContextObjectViolation
o GetContextObjectViolationCount
public virtual HRESULT GetContextObjectViolationCount(int& oNumber)
Implements a function from an interface.
See also:
CATIPspValidation.GetContextObjectViolationCount
o GetDescriptions
protected virtual int GetDescriptions( const CATListValCATUnicodeString& iLKeys,
CATListValCATUnicodeString& 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 HRESULT GetDocColumnTitles(CATListValCATUnicodeString& oDocTitles,
CATListValCATUnicodeString& oObjectTitles)
Implements a function from an interface.
See also:
CATIPspValidation.GetDocColumnTitles
o GetResource
protected virtual HRESULT GetResource(CATUnicodeString& 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 HRESULT GetType(CATUnicodeString& 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 HRESULT GetValidationChecks(CATListValCATUnicodeString& oChecks)
Implements a function from an interface.
See also:
CATIPspValidation.GetValidationChecks
o GetViolationObjectType
public virtual HRESULT GetViolationObjectType(CATUnicodeString& oType)
Implements a function from an interface.
See also:
CATIPspValidation.GetViolationObjectType
o IsAFromToCheck
public virtual HRESULT IsAFromToCheck()
Implements a function from an interface.
See also:
CATIPspValidation.IsAFromToCheck
o IsAnIntegrationCheck
public virtual HRESULT IsAnIntegrationCheck()
Implements a function from an interface.
See also:
CATIPspValidation.IsAnIntegrationCheck
o IsMemberAViolation
public virtual HRESULT IsMemberAViolation( const CATIPspGroup* iGroup,
const CATIUnknownList* iMembers,
const IUnknown* iObject,
const CATListValCATUnicodeString& iChecks,
CATListPV** oViolation,
const unsigned int& iErrorFile= 0 )
Implements a function from an interface.
See also:
CATIPspValidation.IsMemberAViolation
o IsObjectAViolation
public virtual HRESULT IsObjectAViolation( const CATBaseUnknown* iObject,
const CATListValCATUnicodeString& iChecks,
CATListPV** oViolation,
const unsigned int& iErrorFile= 0 )
Implements a function from an interface.
See also:
CATIPspValidation.IsObjectAViolation
o LogContextObject
public virtual HRESULT LogContextObject( const CATBaseUnknown* iObject,
const unsigned int& iErrorFile=0 )
Implements a function from an interface.
See also:
CATIPspValidation.LogContextObject
o PrintErrorMessage
protected virtual HRESULT PrintErrorMessage( const unsigned int& iErrorFile,
const CATUnicodeString& iCheck,
const CATUnicodeString& iErrorKey,
const CATListValCATUnicodeString& 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.