All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface ENOVIRulesValidator

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

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


interface ENOVIRulesValidator

Interface for validating variant rules within the context of a configurable object(s).

Role: Validates rule against a configurable context(s).


Method Index


o Validate(CATIConfigurable_var&,CATListOfCATVpmInfo&)
Validates a variant rule against a single configurable object.
o Validate(CATListOfCATVpmInfo&)
Validates a variant rule against all configurable objects it is attached to.
o ValidateAttach(CATIConfigurable_var&,CATListOfCATVpmInfo&)
Validates attachment of a variant rule to a configurable object.
o ValidateModification(CATICfgORExpression_var&,CATListOfCATVpmInfo&)
Validates modification to OR condition of an variant rule.
o ValidateModification(CATICfgORExpression_var&,CATListValCATICfgSimpleSpecification_var&,CATListOfCATVpmInfo&)
Validates modification to if condition and included specifications of an inclusion variant rule.
o ValidateModification(CATListValCATICfgSimpleSpecification_var&,CATListOfCATVpmInfo&)
Validates modification to included specifications of an inclusion variant rule.

Methods


o Validate
public virtual HRESULT Validate(CATIConfigurable_var& iContext,
CATListOfCATVpmInfo& oMsgs) = 0
Validates a variant rule against a single configurable object.
Parameters:
iContext
Configurable object rule is validated against.
oMsg
List of violation messages.
Returns:
Legal Values:
S_OK
Rule does not violate any validation criteria. oMsgs should be empty.
S_FALSE
Rule violates some validation criteria. Check oMsgs for violation messages.
E_FAIL
Validation failed because of an internal error.
o Validate
public virtual HRESULT Validate(CATListOfCATVpmInfo& oMsgs) = 0
Validates a variant rule against all configurable objects it is attached to.
Parameters:
iContext
Configurable object rule is validated against.
oMsg
List of violation messages.
Returns:
Legal Values:
S_OK
Rule does not violate any validation criteria. oMsgs should be empty.
S_FALSE
Rule violates some validation criteria. Check oMsgs for violation messages.
E_FAIL
Validation failed because of an internal error.
o ValidateAttach
public virtual HRESULT ValidateAttach(CATIConfigurable_var& iContext,
CATListOfCATVpmInfo& oMsgs) = 0
Validates attachment of a variant rule to a configurable object.
Parameters:
iContext
Configurable object rule is being attached to.
oMsg
List of violation messages.
Returns:
Legal Values:
S_OK
Attach does not violate any validation criteria. oMsgs should be empty.
S_FALSE
Attach violates some validation criteria. Check oMsgs for violation messages.
E_FAIL
Validation failed because of an internal error.
o ValidateModification
public virtual HRESULT ValidateModification(CATICfgORExpression_var& iExp,
CATListOfCATVpmInfo& oMsgs) = 0
Validates modification to OR condition of an variant rule.
Parameters:
iExp
Expression being modified.
oMsg
List of violation messages.
Returns:
Legal Values:
S_OK
Modification does not violate any validation criteria. oMsgs should be empty.
S_FALSE
Modification violates some validation rules. Check oMsgs for violation messages.
E_FAIL
Validation failed because of an internal error.
o ValidateModification
public virtual HRESULT ValidateModification(CATICfgORExpression_var& iExp,
CATListValCATICfgSimpleSpecification_var& iSpecs,
CATListOfCATVpmInfo& oMsgs) = 0
Validates modification to if condition and included specifications of an inclusion variant rule. Note: An implementation of this method would not be meaningful for an expression variant rule.
Parameters:
iExp
Expression being modified.
iSpecs
Included specifications begin modified.
oMsg
List of violation messages.
Returns:
Legal Values:
S_OK
Modification does not violate any validation criteria. oMsgs should be empty.
S_FALSE
Modification violates some validation criteria. Check oMsgs for violation messages.
E_FAIL
Validation failed because of an internal error.
o ValidateModification
public virtual HRESULT ValidateModification(CATListValCATICfgSimpleSpecification_var& iSpecs,
CATListOfCATVpmInfo& oMsgs) = 0
Validates modification to included specifications of an inclusion variant rule. Note: An implementation of this method would not be meaningful for an expression variant rule.
Parameters:
iExp
Included specifications being modified.
oMsg
List of violation messages.
Returns:
Legal Values:
S_OK
Modification does not violate any validation criteria. oMsgs should be empty.
S_FALSE
Modification violates some validation criteria. Check oMsgs for violation messages.
E_FAIL
Validation failed because of an internal error.

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

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