PLMValidationInterfaces Interface CATIVALFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIVALFactory
Interface to manage the Validation factory.
Legal states for the factory:
- Creation
- The factory is in a state that enables the creation (connected, not inside a forbidden operation).
- Browsing
- The factory is in a state that enables the browsing (connected).
Errors not documented on each method:
- E_OUTOFMEMORY
- One memory allocation fails.
- E_UNEXPECTED
- There is an unexpected failure.
Method Index
- o
CreateValidation(CATIVALValidation*&)
- Creates a Validation.
- o
ListValidations(CATListValCATBaseUnknown_var&)
- Retrieves the list of Validations managed by the Validation factory.
Methods
o CreateValidation
| public virtual CreateValidation( | | opiValidation) |
-
Creates a Validation. The current environment is used.
- Parameters:
-
- opiValidation
- [out, CATBaseUnknown#Release] The created Validation.
Legal values:
- Valid
- The Validation is valid.
- NULL
- The Validation is not created.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Validation is successfully created.
- E_FAIL
- There is an error that is documented in the attached CATError.
Cases Matrix:
| this | opiValidation | HRESULT |
| Creation | Valid | S_OK |
| Not Creation | NULL | E_FAIL |
o ListValidations
| public virtual ListValidations( | | oValidationsList) |
-
Retrieves the list of Validations managed by the Validation factory.
- Parameters:
-
- oValidationsList
- The list of Validations. Warning this list is cleaned before treatment.
Legal values:
- Empty
- There is no Validations.
- Filled
- There are some Validations (in this case the order is not guaranteed).
- Returns:
- HRESULT
Legal values:
- S_OK
- The list (Empty or Filled) is successfully returned.
- E_FAIL
- There is an error that is documented in the attached CATError.
Cases Matrix:
| this | oValidationsList | HRESULT |
| Browsing without Validation | Empty | S_OK |
| Browsing with Validation | Filled | S_OK |
| Not Browsing | Empty | E_FAIL |
This object is included in the file: CATIVALFactory.h
If needed, your Imakefile.mk should include the module: PLMValidationItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.