Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMValidationInterfaces Interface CATIVALReview

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

interface CATIVALReview

Interface to manage Review.

Errors not documented on each method:

E_OUTOFMEMORY: One memory allocation fails.
E_UNEXPECTED: There is an unexpected failure.

Method Index

o CreateReply(CATIVALReview*&): Creates a Reply.
o GetFactory(IID&,void**): Retrieves the factory to manage data inside Review.
o GetReplied(CATIVALReview*&): Retrieves the original Review if this is a Reply.
o GetValidation(CATIVALValidation*&): Retrieves the Validation.
o ListReplies(CATListValCATBaseUnknown_var&): Retrieves the list of Replies.

Methods

o CreateReply

public virtual CreateReply( opiReply)

Creates a Reply. The current environment is used.

Parameters:

opiReply

[out, CATBaseUnknown#Release] The created Reply.
Legal values:

Valid: The Reply is valid.
NULL: The Reply is not created.

Returns:

HRESULT
Legal values:

S_OK: The Reply is succesfully created.
E_FAIL: The Review is not alive.

Cases Matrix:

this	ipiEnv	opiReply	HRESULT
Alive without Replies	Valid or NULL	Valid	S_OK
Alive with Replies	Valid or NULL	Valid	S_OK
Alive	Not valid	NULL	E_INVALIDARG
Not Alive	Valid	NULL	E_FAIL

o GetFactory

public virtual GetFactory(	const	`iIID`,
		`opiSupport`)

Retrieves the factory to manage data inside Review.

Parameters:

iIID

The IID of the interface.

opiSupport

[out, CATBaseUnknown#Release] The support.
Legal values:

Valid: The support is valid.
NULL: There is an error.

Returns:

HRESULT
Legal values:

S_OK: The support is successfully returned.
E_FAIL: The Entity is not alive.
E_NOINTERFACE: The interface does not exist on the support.

Cases Matrix:

this	iIID	opiSupport	HRESULT
Alive	Valid	Valid	S_OK
Alive	Not valid	Valid	E_NOINTERFACE
Not Alive	Valid	NULL	E_FAIL

o GetReplied

public virtual GetReplied( opiReview)

Retrieves the original Review if this is a Reply.

Parameters:

opiReview

[out, CATBaseUnknown#Release] The original Review.
Legal values:

Valid: The Review is valid.
NULL: This is not a Reply.

Returns:

HRESULT
Legal values:

S_OK: The Review is succesfully returned.
S_FALSE: The Review is not a Reply.
E_FAIL: The Review is not alive.

Cases Matrix:

this	opiReview	HRESULT
Alive Reply	Valid	S_OK
Alive Review but not a Reply	NULL	S_FALSE
Not Alive	NULL	E_FAIL

o GetValidation

public virtual GetValidation( opiValidation)

Retrieves the Validation.

Parameters:

opiValidation

[out, CATBaseUnknown#Release] The original Validation.
Legal values:

Valid: The Validation is valid.
NULL: There is an error.

Returns:

HRESULT
Legal values:

S_OK: The Validation is succesfully returned.
E_FAIL: The Review is not alive.

Cases Matrix:

this	opiValidation	HRESULT
Alive	Valid	S_OK
Not Alive	NULL	E_FAIL

o ListReplies

public virtual ListReplies( oRepliesList)

Retrieves the list of Replies.

Parameters:

oRepliesList

The list of Replies. Warning this list is cleaned before treatment.
Legal values:

Empty: There is no Replies or there is an error.
Filled: There are some Replies (in this case the order is not specified).

Returns:

HRESULT
Legal values:

S_OK: The list is successfully returned.
E_FAIL: The Review is not alive.

Cases Matrix:

this	oRepliesList	HRESULT
Alive without Replies	Empty	S_OK
Alive with Replies	Filled	S_OK
Not Alive	Empty	E_FAIL

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