All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATICfgUEValidateEff

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

Usage: you can freely reimplement this interface.


interface CATICfgUEValidateEff

Interface to validate effectivity expressions.
Role: This interface can be implemented to validate effectivity expressions. Any instance of a class implementing CATIVpmFactoryManager ( CATIVpmFactoryManager ) a DS component. (like CATICfgManager can be used to query for the implementation of this interface.

See also:
CATICfgManager


Method Index


o ValidateEffectivity(CATICfgBasicEffectivity_var&,CATUnicodeString&,CATUnicodeString&,CATIConfigurableObject_var)
Validates the Effectivity expression of the Confiruable Object.
o ValidateEffectivity(CATICfgNormalValue_var&,CATUnicodeString&,CATUnicodeString&,CATIConfigurableObject_var)
Validates the Effectivity expression of the Confiruable Object.
o ValidateEffectivity(CATICfgORExpression_var&,CATUnicodeString&,CATUnicodeString&,CATIConfigurableObject_var)
Validates the Effectivity expression of the Confiruable Object.
o ValidateEffectivity(CATListOfCATILinkableObject&,CATICfgBasicEffectivity_var&,CATUnicodeString&,CATUnicodeString&,CATIConfigurableObject_var)
Validates the Effectivity expression of the Confiruable Object.

Methods


o ValidateEffectivity
public virtual HRESULT ValidateEffectivity( const CATICfgBasicEffectivity_var& iObject,
const CATUnicodeString& iDomain,
const CATUnicodeString& iModName,
const CATIConfigurableObject_var iCV) = 0
Validates the Effectivity expression of the Confiruable Object.
Parameters:
iObject
The BasicEffectivity object which holds the effectivity information.
iDomain
The name of the domain for which this effectivity is being validated. This arguement is available so the developers can get specific validation messages to trace.
iModName
The name of the Modification(if any) for which this effectivity is being validated. This arguement is available so the developers can get specific validation messages to trace.
iCV
The ConfigurableObject which holds the configuration of the object for which the effectivity is being validated.
Returns:
  • S_OK if the Validation was successful.
  • S_FALSE if the Validation method was successful but the validation failed.
  • E_FAIL if the Validation method failedl.
o ValidateEffectivity
public virtual HRESULT ValidateEffectivity( const CATICfgNormalValue_var& iObject,
const CATUnicodeString& iDomain,
const CATUnicodeString& iModName,
const CATIConfigurableObject_var iCV) = 0
Validates the Effectivity expression of the Confiruable Object.
Parameters:
iObject
The NormalValue which holds the effectivity information.
iDomain
The name of the domain for which this effectivity is being validated. This arguement is available so the developers can get specific validation messages to trace.
iModName
The name of the Modification(if any) for which this effectivity is being validated. This arguement is available so the developers can get specific validation messages to trace.
iCV
The ConfigurableObject which holds the configuration of the object for which the effectivity is being validated.
Returns:
  • S_OK if the Validation was successful.
  • S_FALSE if the Validation method was successful but the validation failed.
  • E_FAIL if the Validation method failedl.
o ValidateEffectivity
public virtual HRESULT ValidateEffectivity( const CATICfgORExpression_var& iObject,
const CATUnicodeString& iDomain,
const CATUnicodeString& iModName,
const CATIConfigurableObject_var iCV) = 0
Validates the Effectivity expression of the Confiruable Object.
Parameters:
iObject
The ORExpression which holds the effectivity information
iDomain
The name of the domain for which this effectivity is being validated. This arguement is available so the developers can get specific validation messages to trace.
iModName
The name of the Modification(if any) for which this effectivity is being validated. This arguement is available so the developers can get specific validation messages to trace.
iCV
The ConfigurableObject which holds the configuration of the object for which the effectivity is being validated.
Returns:
  • S_OK if the Validation was successful.
  • S_FALSE if the Validation method was successful but the validation failed.
  • E_FAIL if the Validation method failedl.
o ValidateEffectivity
public virtual HRESULT ValidateEffectivity( const CATListOfCATILinkableObject& iObjects,
const CATICfgBasicEffectivity_var& iObject,
const CATUnicodeString& iDomain,
const CATUnicodeString& iModName,
const CATIConfigurableObject_var iCV) = 0
Validates the Effectivity expression of the Confiruable Object.
Parameters:
iObjects
The Objects on which the validate eff is asked.
iObject
The BasicEffectivity object which holds the effectivity information.
iDomain
The name of the domain for which this effectivity is being validated. This arguement is available so the developers can get specific validation messages to trace.
iModName
The name of the Modification(if any) for which this effectivity is being validated. This arguement is available so the developers can get specific validation messages to trace.
iCV
The ConfigurableObject which holds the configuration of the object for which the effectivity is being validated.
Returns:
  • S_OK if the Validation was successful.
  • S_FALSE if the Validation method was successful but the validation failed.
  • E_FAIL if the Validation method failedl.

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

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