Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMValidationInterfaces Interface CATIVALValidation

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

interface CATIVALValidation

Interface to manage a Validation.

Errors not documented on each method:

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

Method Index

o AddValidated(CATOmbObjectInContext*): Adds a Validated.
o CreateCheck(CATIVALCheck*&): Creates an Check.
o CreateConcern(CATIVALConcern*&): Creates an Concern.
o CreateReview(CATIVALReview*&): Creates a Review.
o GetContextRoot(CATIVALContextRoot*&): Retrieves the Context Root of the Validation.
o GetType(CATUnicodeString&): Retrieves the type of the Validation.
o ListChecks(CATListValCATBaseUnknown_var&): Retrieves the list of Checks.
o ListConcerns(CATListValCATBaseUnknown_var&): Retrieves the list of Concerns.
o ListReviews(CATListValCATBaseUnknown_var&): Retrieves the list of Reviews.
o ListValidateds(CATListValCATBaseUnknown_var&): Retrieves the list of Validateds.
o LoadValidateds(): Loads the Validateds of the Validation.
o RemoveValidated(int): Removes a Validated.

Methods

o AddValidated

public virtual AddValidated( ipiValidated)

Adds a Validated.

Parameters:

ipiValidated

The Validated to add.
Legal values:

Not exist: The provided linkable can be a Validated and is not already defined as Validated.
Exist: The provided linkable can be a Validated and is already defined as Validated.
Not valid: The provided linkable cannot be a Validated.

Returns:

HRESULT
Legal values:

S_OK: The validated is successfully added.
E_INVALIDARG: The provided linkable cannot be a Validated or already exists.
E_FAIL: The Validation is not alive.

Cases Matrix:

this	ipiValidated	HRESULT
Alive	Not valid	E_INVALIDARG
Alive	Exist	E_INVALIDARG
Alive without Validateds	Not exist	S_OK
Alive with Validateds	Not exist	S_OK
Not Alive	Not exist	E_FAIL

o CreateCheck

public virtual CreateCheck( opiCheck)

Creates an Check. The current environment is used.

Parameters:

opiCheck

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

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

Returns:

HRESULT
Legal values:

S_OK: The Check is succesfully created.
E_FAIL: The Validation is not alive.

Cases Matrix:

this	opiCheck	HRESULT
Alive without Checks	Valid	S_OK
Alive with Checks	Valid	S_OK
Not Alive	NULL	E_FAIL

o CreateConcern

public virtual CreateConcern( opiConcern)

Creates an Concern. The current environment is used.

Parameters:

opiConcern

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

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

Returns:

HRESULT
Legal values:

S_OK: The Concern is succesfully created.
E_FAIL: The Validation is not alive.

Cases Matrix:

this	opiConcern	HRESULT
Alive without Concerns	Valid	S_OK
Alive with Concerns	Valid	S_OK
Not Alive	NULL	E_FAIL

o CreateReview

public virtual CreateReview( opiReview)

Creates a Review. The current environment is used.

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 Validation 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 GetContextRoot

public virtual GetContextRoot( opiContext)

Retrieves the Context Root of the Validation.

Parameters:

opiContext

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

Valid: The Context Root is valid.
NULL: There is an error.

Returns:

HRESULT
Legal values:

S_OK: The Context Root is successfully returned.
E_FAIL: The Validation is not alive.

Cases Matrix:

this	opiContext	HRESULT
Alive	Valid	S_OK
Not Alive	NULL	E_FAIL

o GetType

public virtual GetType( ouType)

Retrieves the type of the Validation.

Parameters:

ouType

The type.
Legal values:

Product: The type attribute is set to Product.
Simulation: The type attribute is set to Simulation.
Image: The type attribute is set to Image.

Returns:

HRESULT
Legal values:

S_OK: The type is successfully returned.
E_FAIL: The Validation is not alive.

Cases Matrix:

this	ouType	HRESULT
Alive and Product	Product	S_OK
Alive and Simulation	Simulation	S_OK
Alive and Image	Image	S_OK
Not Alive	Empty string	E_FAIL

o ListChecks

public virtual ListChecks( oChecksList)

Retrieves the list of Checks.

Parameters:

oChecksList

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

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

Returns:

HRESULT
Legal values:

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

Cases Matrix:

this	oChecksList	HRESULT
Alive without Checks	Empty	S_OK
Alive with Checks	Filled	S_OK
Not Alive	Empty	E_FAIL

o ListConcerns

public virtual ListConcerns( oConcernsList)

Retrieves the list of Concerns.

Parameters:

oConcernsList

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

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

Returns:

HRESULT
Legal values:

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

Cases Matrix:

this	oConcernsList	HRESULT
Alive without Concerns	Empty	S_OK
Alive with Concerns	Filled	S_OK
Not Alive	Empty	E_FAIL

o ListReviews

public virtual ListReviews( oReviewsList)

Retrieves the list of Reviews.

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 Validation 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

o ListValidateds

public virtual ListValidateds( oValidatedsList)

Retrieves the list of Validateds.

Parameters:

oValidatedsList

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

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

Returns:

HRESULT
Legal values:

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

Cases Matrix:

this	oValidatedsList	HRESULT
Alive without Validateds	Empty	S_OK
Alive with Validateds already in session	Filled	S_OK
Alive with some Validateds not is session	Filled	S_FALSE
Not Alive	Empty	E_FAIL

o LoadValidateds

public virtual LoadValidateds(

)

Loads the Validateds of the Validation.

Returns:

HRESULT
Legal values:

S_OK: The Validateds are successfully loaded and returned.
E_FAIL: The Validation is not alive or the Validateds are not set.

Cases Matrix:

this	HRESULT
Alive without Validateds	E_FAIL
Alive with removed Validateds	E_FAIL
Alive with Validateds already in session	S_FALSE
Alive with Validateds not in session	S_OK
Not Alive	E_FAIL

o RemoveValidated

public virtual RemoveValidated( iiPosition)

Removes a Validated.

Parameters:

iiPosition

The position of the Validated to remove.
Legal values:

Valid: The position is consistent with the number of Validateds.
Not valid: The position is not consistent with the number of Validateds.

Returns:

HRESULT
Legal values:

S_OK: The validated is successfully removed.
E_INVALIDARG: The Validated is not valid.
E_FAIL: The Validation is not alive.

Cases Matrix:

this	iiPosition	HRESULT
Alive	Not valid	E_INVALIDARG
Alive with Validateds	Valid	S_OK
Not Alive	Valid	E_FAIL

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