PLMValidationInterfaces Interface CATIVALContextRoot

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

interface CATIVALContextRoot

Interface to manage a Validation context.

Errors not documented on each method:

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

Method Index

o AddContext(CATBaseUnknown*): Adds a Context.
o ListContexts(CATListValCATBaseUnknown_var&): Retrieves the list of Contexts.
o LoadContexts(): Loads the Contexts of the Validation.
o RemoveContext(CATBaseUnknown*): Removes a Context.

Methods

o AddContext

public virtual AddContext( ipiContext)

Adds a Context.

Parameters:

ipiContext

The Context to add.
Legal values:

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

Returns:

HRESULT
Legal values:

S_OK: The Context is successfully added.
E_INVALIDARG: The provided object cannot be a Context or is already defined as Context.
E_FAIL: The Validation is not alive.

Cases Matrix:

this	ipiContext	HRESULT
Alive	Not valid	E_INVALIDARG
Alive	Exist	E_INVALIDARG
Alive without Contexts	Not exist	S_OK
Alive with Contexts	Not exist	S_OK
Not Alive	Not exist	E_FAIL

o ListContexts

public virtual ListContexts( oContextsList)

Retrieves the list of Contexts.

Parameters:

oContextsList

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

Empty: There is no defined Context or there is an error.
Filled: There are some defined Contexts (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	oContextsList	HRESULT
Alive without Contexts	Empty	S_OK
Alive with Contexts already in session	Filled	S_OK
Alive with some Contexts not is session	Filled	S_FALSE
Not Alive	Empty	E_FAIL

o LoadContexts

public virtual LoadContexts(

)

Loads the Contexts of the Validation.

Returns:

HRESULT
Legal values:

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

Cases Matrix:

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

o RemoveContext

public virtual RemoveContext( ipiContext)

Removes a Context.

Parameters:

ipiContext

The ipiContext to remove.
Legal values:

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

Returns:

HRESULT
Legal values:

S_OK: The Context is successfully removed.
E_INVALIDARG: The provided object cannot be a Context or is not already defined as Context.
E_FAIL: The Validation is not alive.

Cases Matrix:

this	ipiContext	HRESULT
Alive	Not valid	E_INVALIDARG
Alive with Contexts	Not exist	E_INVALIDARG
Alive with Contexts	Exist	S_OK
Not Alive	Exist	E_FAIL

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