All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMSRMExposedServices Interface CATIPLMChannelReportData

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

interface CATIPLMChannelReportData

Class representing a report for a particular object in the context of PLMChannel operations.

Role: A PLM Channel is an exchange context created between two specific repositories in order to allow optimized back and forth data exchanges. This class provides a report (operation performed and/or error status) for a specific exchanged PLMObject. (@see CATPLMExchangeChannelServices )

Method Index

o GetAdditionalInfo(CATListOfCATUnicodeString*): Get Additional info for this object.
o GetErrorKey(CATString&): Get the error key identifying the error in case of failure.
o GetErrorPropagationStatus(CATPLMChannelOperationPropagationStatus&): Identify the information if current object is responsible of current error.
o GetObjectId(CATIAdpPLMIdentificator*&): Get the object Id corresponding to the report data.
o GetOperationStatus(CATPLMChannelOperationStatus&): Get the operation status of the PLMChannel operation for the particular object id.
o GetOriginalErrorMessage(CATUnicodeString&): Get the original error message as displayed when the operation was performed.
o GetPerformedOperation(CATPLMChannelOperationType&): Get the operation performed on the object.

o CATPLMChannelOperationPropagationStatus: Operation propagation status for this particular object.
o CATPLMChannelOperationStatus: Specific PLMChannel operation status for an ObjectId.
o CATPLMChannelOperationType: The performed operation against the object.

Methods

o GetAdditionalInfo

public virtual GetAdditionalInfo( oAdditionalInfos)

Get Additional info for this object.
Role: This method returns the optional additional infos that may be contained in the input of published objects.

Parameters:

oAdditionalInfos: [out] The operation type performed on the object.

Returns:

An HRESULT value.
Legal values:

S_OK: The operation succeeded.
E_FAIL: if there is any other problem.

o GetErrorKey

public virtual GetErrorKey( oErrorKey)

Get the error key identifying the error in case of failure.
Role: This method is used to get the error key identifying the error in case of failure during , and .

Parameters:

oErrorKey: [out] The error key of the error in case of failure.

Returns:

An HRESULT value.
Legal values:

S_OK: if the initialization of the report succeeds.
S_FALSE: if the original operation was not a failure
E_INVALIDARG: the file is not a briefcase or does not contain any report.
E_FAIL: if there is any other problem.

o GetErrorPropagationStatus

public virtual GetErrorPropagationStatus( oChannelOperationPropagationStatus)

Identify the information if current object is responsible of current error.
Role: This method is used to know if the object in error is a faulty object(Error) or if the operation failed due to another object or issue (ErrorByPropagation).

Parameters:

oChannelOperationPropagationStatus: [out] The error propagation status.

Returns:

An HRESULT value.
Legal values:

S_OK: if the initialization of the report succeeds.
S_FALSE: if the original operation was not a failure
E_FAIL: if there is any other problem.

o GetObjectId

public virtual GetObjectId( oObjectId)

Get the object Id corresponding to the report data.
Role: This method helps to retrieve the Id of the object in error.

Parameters:

oObjectId: [out] The CATIAdpPLMIdentificator corresponding to the report data.

Returns:

An HRESULT value.
Legal values:

S_OK: if the CATIAdpPLMIdentificator is correctly retrieved.
E_FAIL: if there is any other problem.

o GetOperationStatus

public virtual GetOperationStatus( oPLMChannelOperationStatus)

Get the operation status of the PLMChannel operation for the particular object id.
Role: This method is used to get the global operation status performed during , and .

Parameters:

oPLMChannelOperationGlobalStatus: [out] The global status of the PLMChannel operation.

Returns:

An HRESULT value.
Legal values:

S_OK: if the initialization of the report succeeds.
E_INVALIDARG: the file is not a briefcase or does not contain any report.
E_FAIL: if there is any other problem.

o GetOriginalErrorMessage

public virtual GetOriginalErrorMessage( oErrorMessage)

Get the original error message as displayed when the operation was performed.
Role: This method is used to get the error message as displayed when the operation was performed. The localization is the one used when the original operation was performed.

Parameters:

oErrorMessage: [out] The original error message.

Returns:

An HRESULT value.
Legal values:

S_OK: if the initialization of the report succeeds.
S_FALSE: if the original operation was not a failure
E_FAIL: if there is any other problem.

o GetPerformedOperation

public virtual GetPerformedOperation( oChannelOperationType)

Get the operation performed on the object.
Role: This method is used to know the operation performed on the object during a PLMChannel operation.

Parameters:

oChannelOperationType: [out] The operation type performed on the object.

Returns:

An HRESULT value.
Legal values:

S_OK: if the initialization of the report succeeds.
S_FALSE: if the original operation was not a failure
E_FAIL: if there is any other problem.

Enumerated Types

o CATPLMChannelOperationPropagationStatus

enum CATPLMChannelOperationPropagationStatus {
  Error,
  ErrorByPropagation
}

Operation propagation status for this particular object.

Parameters:

Error: The object is a faulty object.
ErrorByPropagation: The object is not responsible of the failure of the operation.

o CATPLMChannelOperationStatus

enum CATPLMChannelOperationStatus {
  Failure,
  Success,
  Warning
}

Specific PLMChannel operation status for an ObjectId.

Parameters:

Failure: The PLMChannel operation failed for this object.
Success: The PLMChannel operation Succeeded for this object.

o CATPLMChannelOperationType

enum CATPLMChannelOperationType {
  None,
  Synchronize_Create,
  Synchronize_Update,
  Synchronize_Delete,
  Synchronize_Ignore,
  Publish,
  Publish_Filtered,
  Detach,
  TransferSiteOwnership_Request,
  TransferSiteOwnership_Emission,
  TransferSiteOwnership_Reception,
  TransferSiteOwnership_Acknowledge,
  Synchronize_ForceUpdate
}

The performed operation against the object.

Parameters:

None: no operation performed on the object.
Synchronize_Create: the object is created in database.
Synchronize_Update: the object is updated in database.
Synchronize_Delete: the object is deleted in database.
Synchronize_Ignore: the object is ignored (if the object is up to date).
Synchronize_ForceUpdate: the object has been updated in database instead of an object creation.
Publish: the object is published.
Publish_Filtered: the object is published but filtered because already up to date on the target site.
Detach: the object is detached.
TransferSiteOwnership_Request: the transfer site ownership of the object is requested.
TransferSiteOwnership_Emission: the transfer site ownership of the object is emitted.
TransferSiteOwnership_Reception: the transfer site ownershpi of the object is received.
TransferSiteOwnership_Acknowledge: the transfer site ownership of the object is acknowledged.

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

PLMSRMExposedServices Interface CATIPLMChannelReportData

Method Index

Enumerated Type Index

Methods

Enumerated Types