All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATPLMIntegrationAccess CATAdpMaturityServices

Usage: you must use this class as is. You should never derive it.

public class CATAdpMaturityServices

Class of services enabling to manage maturity of references in the database.

Role: Provides a set of services enabling the user to manage maturity of a reference in the database.

To process a lock operation, you will need a PLM identificator, interface pointer. You can use to retrieve it.

Method Index

o ApplyMaturityTransition(CATIAdpPLMIdentificator*,CATUnicodeString&,CATIAdpPLMErrorReviewer*): Applies the provided transition to the provided reference.
o GetStateAndPossibleTransitions(CATIAdpPLMIdentificator*,CATUnicodeString&,CATLISTV(CATUnicodeString)&,CATIAdpPLMErrorReviewer*): Returns the current maturity state of a reference and its possible maturity transitions.

Methods

o ApplyMaturityTransition

public static ApplyMaturityTransition(		`iComponent`,
	const	`iTransition`,
		`iopErrorReviewer`	`= NULL` )

Applies the provided transition to the provided reference.
Role: Makes the maturity of the reference evolve in the database by applying the provided transition.

The database informations are imbedded in the identifier of the object itself.
ERR_02_MATURITY error is available through if the given transition cannot be applied to the component.
Error is available through if no maturity graph is defined in the metadata for the component.

Parameters:

iComponent

[in] The identifier of the reference which maturity is required to evolve. If so, result will be E_FAIL. It is invalid if :

The pointer is nul.
Or, if it is not a reference (CATPLMCoreReference or CATPLMCoreRepReference).

iTransition

[in] The transition requested to be applied to the reference.

To ensure that the transition can be applied, make sure it was obtained through the

Null strings are invalid transition and result in a E_INVALIDARG return.

iopErrorReviewer

[inout] The ErrorReviewer dedicated to store and handle all PLM Errors raised during the execution of this service.

Returns:

S_OK if the the maturity transition could successfully be applied to the reference in the database.
E_INVALIDARG if iComponent or iTransition are invalid.
E_FAIL if the operation failed. Nothing was done during the operation. The blocking error can be accessed through method.

o GetStateAndPossibleTransitions

public static GetStateAndPossibleTransitions(	`iComponent`,
	`oState`,
	`oTransitions`,
	`iopErrorReviewer`	`= NULL` )

Returns the current maturity state of a reference and its possible maturity transitions.
Role: Retrieves in the database the current maturity state of a reference and the transitions which can be applied on the current maturity state.

The database informations are imbedded in the identifier of the object itself.
The applicable transitions depend of the input object type and of its current maturity state.
Error is available through if no maturity graph is defined in the metadata for the component.

Parameters:

iComponent

[in] The identifier of the reference. It is invalid if :

The pointer is nul.
Or, if it is not a reference (CATPLMCoreReference or CATPLMCoreRepReference).

oState

[out] The current maturity state of the reference.

oTransitions

[out] The transitions which can possibly be applied to the reference to make its maturity state evolve.