PLMValidationInterfaces Interface CATIVALCheck

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

interface CATIVALCheck

Interface to manage Check.

Errors not documented on each method:

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

Method Index

o AddRequirement(CATBaseUnknown*): Adds a Requirement.
o ListRequirements(CATListValCATBaseUnknown_var&): Retrieves the list of Requirements.
o LoadRequirements(): Loads the Requirements.
o RemoveRequirement(CATBaseUnknown*): Removes a Requirement.

Methods

o AddRequirement

public virtual AddRequirement( ipiRequirement)

Adds a Requirement.

Parameters:

ipiRequirement

The Requirement to add.
Legal values:

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

Returns:

HRESULT
Legal values:

S_OK: The validated is successfully added.
E_INVALIDARG: The Requirement is not valid or already exists.
E_FAIL: The Validation is not alive.

Cases Matrix:

this	ipiRequirement	HRESULT
Alive	Not valid	E_INVALIDARG
Alive	Exist	E_INVALIDARG
Alive without Requirements	Not exist	S_OK
Alive with Requirements	Not exist	S_OK
Not Alive	Not exist	E_FAIL

o ListRequirements

public virtual ListRequirements( oRequirementsList)

Retrieves the list of Requirements.

Parameters:

oRequirementsList

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

Empty: There is no Requirement or there is an error.
Filled: There are some Requirements (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	oRequirementsList	HRESULT
Alive without Requirements	Empty	S_OK
Alive with Requirements	Filled	S_OK
Not Alive	Empty	E_FAIL

o LoadRequirements

public virtual LoadRequirements(

)

Loads the Requirements.

Returns:

HRESULT
Legal values:

S_OK: The Requirements are successfully loaded.
S_FALSE: The Requirements are already in session.
E_FAIL: The Validation is not alive or there is no defined Requirements.

Cases Matrix:

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

o RemoveRequirement

public virtual RemoveRequirement( ipiRequirement)

Removes a Requirement.

Parameters:

ipiRequirement

The ipiRequirement to remove.
Legal values:

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

Returns:

HRESULT
Legal values:

S_OK: The validated is successfully removed.
E_INVALIDARG: The Requirement is not valid or does not exist.
E_FAIL: The Validation is not alive.

Cases Matrix:

this	ipiRequirement	HRESULT
Alive	Not valid	E_INVALIDARG
Alive with Requirements	Not exist	E_INVALIDARG
Alive with Requirements	Exist	S_OK
Not Alive	Exist	E_FAIL

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