CATPLMIntegrationAccess CATAdpVersioningServices

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

public class CATAdpVersioningServices

Class of services enabling to manage versioning of components in the database.

Role: Provides a set of services enabling the user to manage versioning of components in the database.

• To process such operations, you will need a . You can obtain it by using Query services before using versioning services ( ).

Method Index

o GetAllVersions(CATIAdpPLMIdentificator*,CATLISTP(CATAdpQueryResult)&,CATIAdpPLMErrorReviewer*)

Gets the available versions of a component.

o NewVersion(CATIAdpPLMIdentificator*,CATTime&,CATIAdpPLMIdentificator*&,CATIAdpPLMErrorReviewer*)

Creates a new version of a component.

Methods

Gets the available versions of a component.
Role: Retrieves in the database all the available versions of a reference or a representation reference.

• The database informations are imbedded in the identifier of the object itself.
• No order is guaranteed in return for the new versions of the component.
• ERR_02_NEWVERSION error is available through if at least one version could not be retrieved for this component.

Parameters:

iComponent

[in] The identifier of the component which versions are required. The component must be a reference or a representation reference. If not, result will be E_INVALIDARG.

oQueryResults

[out] Returned list with all retrieved objects given access through

contract.

• The list is emptied by the beginning of the method.
• You must delete the elements of the list when useless.
• These objects are not loaded in a session.
• Objects are identified through by using the method.
• The attributes obtained through the method are PLM_ExternalID and V_Version.

iopErrorReviewer

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

Returns:

• S_OK if the all the versions of the component could be retrieved in the database.
• E_INVALIDARG if iComponent is not a reference or is null.
• E_FAIL if the operation failed. The returned list is empty. The blocking error can be accessed through method.

Creates a new version of a component.
Role: Creates a new version of a reference or representation reference in the database. This operation is not available if the corresponding component is loaded in the session, nor if the component is not the last version of a version family.

• The database informations are imbedded in the identifier of the object itself.
• ERR_01_NEWVERSION error is available through if the provided component is in session.

Parameters:

iObjectToTreat

[in] The identifier of the component to version.

• The component must not be loaded in a session. If so, result will be E_FAIL.
• The component must be a reference or a representation reference. If not, result will be E_INVALIDARG.
• The component must be the last version of a version family. If not, the call will result in a server error.

iApplicabilityDate

[in] The applicability date of the new version of the component.

oVersioned

[out] The identifier of the new version of the component.

iopErrorReviewer

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

Returns:

• S_OK if the new version of the component was created in the database.
• E_INVALIDARG if iObjectToTreat is not a reference or is null.
• E_FAIL if the new version could not be created in the database. Nothing was done during the operation. The blocking error can be accessed through method.

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.