Package com.ptc.windchill.enterprise.report

Class ReportServiceHelper

java.lang.Object

com.ptc.windchill.enterprise.report.ReportServiceHelper

All Implemented Interfaces:

RemoteAccess

public class ReportServiceHelper
extends Object
implements RemoteAccess

This helper class executes windchill report template based reports and third party jasper reports

Supported API: true

Extendable: false

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ReportServiceHelper.ReportFormatType	ReportFormatType enum used in executeThirdPartyReport it passes index value to executeThirdPartyReport Supported API: true Extendable: false

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELEGATE_NAME	DELEGATE_NAME to get report in formats of PDF, XML, CSV, HTML_WITH_SORTING, HTML_WITH_MERGING, HTML_WITH_SORTING_AND_MERGING Supported API: true Extendable: false
static final String	FORMAT	FORMAT parameter to declare FORMAT_DELEGATE Supported API: true Extendable: false
static final String	FORMAT_DELEGATE	FORMAT_DELEGATE parameter to declare report will have delegated format Supported API: true Extendable: false
static final String	IGNORE_CUSTOM_INPUT_PAGE	Custom input page will be ignore Supported API: true Extendable: false
static final String	SORT_ORDER	SORT_ORDER to get report in sorted order.

Fields inherited from interface wt.method.RemoteAccess

versionID

Method Summary

Modifier and Type	Method	Description
static void	executeReport(WTReference reference, Map params, ReportServiceHelper.ReportFormatType reportFormatType, OutputStream output)	Executes the report on server and writes the output to the OutputStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FORMAT

public static final String FORMAT

FORMAT parameter to declare FORMAT_DELEGATE

Supported API: true

Extendable: false

See Also:

• Constant Field Values

FORMAT_DELEGATE

public static final String FORMAT_DELEGATE

FORMAT_DELEGATE parameter to declare report will have delegated format

Supported API: true

Extendable: false

See Also:

• Constant Field Values

DELEGATE_NAME

public static final String DELEGATE_NAME

DELEGATE_NAME to get report in formats of PDF, XML, CSV, HTML_WITH_SORTING, HTML_WITH_MERGING, HTML_WITH_SORTING_AND_MERGING

Supported API: true

Extendable: false

See Also:

• Constant Field Values

SORT_ORDER

public static final String SORT_ORDER

SORT_ORDER to get report in sorted order. Can be use with parameters like SORT_ASCENDING, SORT_DESCENDING, SORT_BY_INDEX

Supported API: true

Extendable: false

See Also:

• Constant Field Values

IGNORE_CUSTOM_INPUT_PAGE

public static final String IGNORE_CUSTOM_INPUT_PAGE

Custom input page will be ignore

Supported API: true

Extendable: false

See Also:

• Constant Field Values

Method Details

executeReport

public static void executeReport(WTReference reference,
 Map params,
 ReportServiceHelper.ReportFormatType reportFormatType,
 OutputStream output)
                          throws WTException

Executes the report on server and writes the output to the OutputStream.

Supported API: true

Parameters:

reference - windchill report WTReference

params - report parameters

reportFormatType - report format type

output - where the output of the report is written to. (This object should be closed by stream creator this method will not close OutputStream object)

Throws:

WTException