All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMIntegrationAccess Interface CATIAdpPLMError

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

interface CATIAdpPLMError

Interface intended to access the content of each unitary PLM Error stored by an ErrorReviewer.

Role: This interface accesses the elementary data on each PLM Error collected by a given ErrorReviewer used while performing PLM server Access operations.
These operations handle PLM components that may be individually involved in an error case: - The component identification is then stored on the PLMError
but the error case might also be a global system problem impacting all components handled by the operation: - No component identification is stored on the PLMError

See also:: , ,

Method Index

o GetError(CATError**): Returns the standard object describing the error.
o GetPLMComponentIdentifier(CATIAdpPLMIdentificator*&): Gets the identifier of the PLM component that raised this error.

Methods

o GetError

public virtual GetError( opError)

Returns the standard object describing the error.

Parameters:

opError: The generic System object describing the error. Refer to CATError class to get all NLS informations about the error message.

Returns:

S_OK : the generic Error has been retrieved from PLMError
E_FAIL : the generic Error retrieval failed. an unexpected NULL output pointer is given.

o GetPLMComponentIdentifier

public virtual GetPLMComponentIdentifier( opAdpIdentificator)

Gets the identifier of the PLM component that raised this error.
Role: This method gets a handle on the unique database identifier of the PLM component that raised this error.

Parameters:

opAdpIdentificator: the handle on the unique identifier of the component in the DataBase

Returns:

S_OK : identification successfull: a valid opAdpIdentificator output pointer is given.
S_FALSE : no component associated to this PLM error: this is a global system error. a NULL output pointer is given.
E_FAIL : identification failed for the component that raised this error: an unexpected NULL output pointer is given.

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