All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMSRMExposedServices Interface CATIPLMChannelReportServices

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

interface CATIPLMChannelReportServices

Interface representing services to access PLMChannel report.

Role: A PLM Channel is an exchange context created between two specific repositories in order to allow optimized back and forth data exchange and ownership transfers. Data exchanges and site ownership transfers are performed using a PLMBriefcase file. A report file for operations performed is generated during , and .

Method Index

o AddAttributeToDataReport(CATIType_var&,CATListValCATAttributeInfos&): Declare PLM attributes to be added on PLM object in report.
o GetChannelReportGlobal(CATIPLMChannelReportGlobal*&): Give the global status of the operation that generated the briefcase.
o GetNextChannelReportData(CATIPLMChannelReportData*&): Give the next report corresponding to a particular data.
o InitReport(CATUnicodeString&): Initialize the report from a briefcase file.

Methods

o AddAttributeToDataReport

public virtual AddAttributeToDataReport(	const	`iType`,
		`iAttrList`)

Declare PLM attributes to be added on PLM object in report.
Role: This method is used to declare PLM attributes to be exposed in data report. (@see CATIPLMChannelReportData )

Parameters:

iType: [in] The global report for the operation.
iAttrList: [in] The global report for the operation.

Returns:

An HRESULT value.
Legal values:

S_OK: Attribute publication request has been successfully recorded.
E_FAIL: if there is any other problem.

o GetChannelReportGlobal

public virtual GetChannelReportGlobal( oReportGlobal)

Give the global status of the operation that generated the briefcase.
Role: This method is used to access to the global status of the operation that generated the briefcase. (@see CATIPLMChannelReportGlobal )

Parameters:

oReportGlobal: [out] The global report for the operation.

Returns:

An HRESULT value.
Legal values:

S_OK: a global report is successfully returned.
E_INVALIDARG: the input parameter is not null.
E_FAIL: if there is any other problem.

o GetNextChannelReportData

public virtual GetNextChannelReportData( oReportData)

Give the next report corresponding to a particular data.
Role: This method is used to scan all the report data generated during a , or ..

Parameters:

oReportData: [out] a report for a particular data.

Returns:

An HRESULT value.
Legal values:

S_OK: a report is successfully returned.
S_FALSE: there is no next data report.
E_INVALIDARG: the input parameter is not null.
E_FAIL: if there is any other problem.

o InitReport

public virtual InitReport( const iReportFilePath)

Initialize the report from a briefcase file.
Role: This method is used to initialize the report from a briefcase created during , and .

Parameters:

iReportFilePath: [in] The report file generated during publish or synchronize.

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.

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