public interface ReportWrapperService
Modifier and Type | Method and Description |
---|---|
DeliveryOptions |
getDeliveryOptions(String userId,
String reportId)
This method returns the delivery options for the report.
|
List<ReportFormat> |
getFormats(String reportId)
This method provides a list of formats supported by the report
|
ReportParameters |
getParameters(String ReportId)
This method retrieves the runtime parameters taken by the report
|
Boolean |
hasParameters(String ReportId)
This method is used to determine whether the report takes any parameters
|
void |
render(String ReportId,
String location,
ReportFormat format,
OutputStream outputStream)
This method renders the report into a given output stream.
|
void |
run(ReportParameters parameters,
ReportMode mode,
DeliveryOptions deliveryOptions,
String reportId)
This method runs the report
|
void |
runAndRender(ReportParameters parameters,
ReportMode mode,
OutputStream outputStream)
This method runs the report and renders in into the given output stream
with no intermediate steps
|
void run(ReportParameters parameters, ReportMode mode, DeliveryOptions deliveryOptions, String reportId)
parameters
- runtime report parametersdeliveryOptions
- delivery options for the reportreportId
- reportId as defined in database-reports.xmlmode
- in which to run the report (ONLINE, BATCH or IMMEDIATE)DeliveryOptions getDeliveryOptions(String userId, String reportId)
List<ReportFormat> getFormats(String reportId)
reportId
- reportId as defined in database-reports.xmlvoid runAndRender(ReportParameters parameters, ReportMode mode, OutputStream outputStream) throws ReportException
parameters
- runtime report parametersoutputStream
- stream to render the resulting reportmode
- in which to run the report (ONLINE, BATCH or IMMEDIATE)ReportException
void render(String ReportId, String location, ReportFormat format, OutputStream outputStream)
ReportId
- reportId as defined in database-reports.xmllocation
- location of the report on diskformat
- format to render the reportoutputStream
- stream to render the resulting reportBoolean hasParameters(String ReportId)
ReportId
- a String
object.ReportParameters getParameters(String ReportId)
ReportId
- a String
object.Copyright © 2020. All rights reserved.