PLMValidationInterfaces Interface CATIREVReviewFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIREVReviewFactory
Interface to manage Reviews which belong to an Owner.
Errors not documented on each method:
- E_OUTOFMEMORY
- One memory allocation fails.
- E_UNEXPECTED
- There is an unexpected failure.
Method Index
- o
CreateReview(CATIREVReview*&)
- Creates a Review.
- o
ListReviews(CATListValCATBaseUnknown_var&)
- Retrieves the list of Reviews which belong to an Owner.
Methods
o CreateReview
| public virtual CreateReview( | | opiReview) |
-
Creates a Review.
- Parameters:
-
- opiReview
- [out, CATBaseUnknown#Release] The created Review.
Legal values:
- Valid
- The Review is valid.
- NULL
- The Review is not created.
- Returns:
- HRESULT
Legal values:
- S_OK
- The Review is succesfully created.
- E_FAIL
- The Owner is not alive.
Cases Matrix:
| this | opiReview | HRESULT |
| Alive without Reviews | Valid | S_OK |
| Alive with Reviews | Valid | S_OK |
| Not Alive | NULL | E_FAIL |
o ListReviews
| public virtual ListReviews( | | oReviewsList) |
-
Retrieves the list of Reviews which belong to an Owner.
- Parameters:
-
- oReviewsList
- The list of Reviews. Warning this list is cleaned before treatment.
Legal values:
- Empty
- There is no Reviews or there is an error.
- Filled
- There are some Reviews (in this case the order is not specified).
- Returns:
- HRESULT
Legal values:
- S_OK
- The list is successfully returned.
- E_FAIL
- The Owner is not alive.
Cases Matrix:
| this | oReviewsList | HRESULT |
| Alive without Reviews | Empty | S_OK |
| Alive with Reviews | Filled | S_OK |
| Not Alive | Empty | E_FAIL |
This object is included in the file: CATIREVReviewFactory.h
If needed, your Imakefile.mk should include the module: PLMValidationItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.