Package com.ptc.windchill.enterprise.report

Interface ReportService

All Known Implementing Classes:

StandardReportService

@RemoteInterface
public interface ReportService

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
default WTSet	getReportByNameAndReportingSystem(String reportName, WBRReportingSystem reportingSystem, String containerPath, Boolean thirdPartyReport)	Deprecated.
default Report	getReportByNameReportingSystemThirdpartyReport(String reportName, WBRReportingSystem reportingSystem, String containerPath, Boolean thirdPartyReport)	This will return the unique Report object by its name, reportingSystem and thirdPartyReport attributes in given containerPath.
URL	getThirdPartyReportExecuteUrl(String searchPath, Map inputParams)	Returns the URL to the report execution page for the third-party report definition for the given search path.
URL	getThirdPartyReportExecuteUrl(ObjectReference windchillReport, Map inputParams)	Returns the URL to the report execution page for the third-party report definition for the given Windchill Report object.

Method Details

getThirdPartyReportExecuteUrl

URL getThirdPartyReportExecuteUrl(ObjectReference windchillReport,
 Map inputParams)
                           throws WTException

Returns the URL to the report execution page for the third-party report definition for the given Windchill Report object.

Supported API: true

Parameters:

windchillReport - Reference to a Windcill Report object

inputParams - Prespecified input parameter values

Returns:

URL

Throws:

WTException

getThirdPartyReportExecuteUrl

URL getThirdPartyReportExecuteUrl(String searchPath,
 Map inputParams)
                           throws WTException

Returns the URL to the report execution page for the third-party report definition for the given search path.

Supported API: true

Parameters:

searchPath -

inputParams -

Returns:

URL

Throws:

WTException

getReportByNameAndReportingSystem

@Deprecated
default WTSet getReportByNameAndReportingSystem(String reportName,
 WBRReportingSystem reportingSystem,
 String containerPath,
 Boolean thirdPartyReport)
                                         throws WTException

Deprecated.

Deprecated: Please refer to @getReportByNameReportingSystemThirdpartyReport API. Get Report Objects By Name, Reporting System and ContainerPath. Supported API: true

Parameters:

reportName - , Name of Report to be Searched, Not Null Parameter

reportingSystem - Reporting System for given Report, If Null, Falls back to See Default WBRReportingSystem.getDefault().

containerPath - Container Path for the Report, If Null, Default : Site

thirdPartyReport - true : Reporting Systems's Reports. false : For Report Builder's Reports. null : Default is false ( Report Builder's Reports )

Returns:

WTSet of inflated Report Objects

Throws:

WTException

getReportByNameReportingSystemThirdpartyReport

default Report getReportByNameReportingSystemThirdpartyReport(String reportName,
 WBRReportingSystem reportingSystem,
 String containerPath,
 Boolean thirdPartyReport)
                                                       throws WTException

This will return the unique Report object by its name, reportingSystem and thirdPartyReport attributes in given containerPath. Supported API: true

Parameters:

reportName - , Name of Report to be Searched, Not Null Parameter

reportingSystem - Reporting System for given Report, null will consider only Windchill report.

containerPath - Container Path for the Report. For null value, default path will be Site.

thirdPartyReport - True value represents that Report belongs to thirdParty reporting SYSTEM, False represents the Windchill report.

Returns:

Inflated Report Object or NULL.

Throws:

WTException