Package com.logicaldoc.report
Class ReportTool
- java.lang.Object
-
- com.logicaldoc.report.ReportTool
-
public class ReportTool extends Object
Utility methods to run custom reports- Since:
- 8.7.3
- Author:
- Marco Meschieri - LogicalDOC
-
-
Constructor Summary
Constructors Constructor Description ReportTool()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Long
execute(long reportId, Map<String,Object> parameters, String sid, String username)
Executes a custom reportLong
execute(String reportName, long tenantId, Map<String,Object> parameters, String sid, String username)
Executes a custom report
-
-
-
Method Detail
-
execute
public Long execute(String reportName, long tenantId, Map<String,Object> parameters, String sid, String username) throws Exception
Executes a custom report- Parameters:
reportName
- name of the custom reporttenantId
- identifier of the tenantparameters
- An optional map of parameters to be used inside the reportsid
- optional identifier of the current sessionusername
- username the user in whose name the method is run- Returns:
- the identifier of the output document
- Throws:
Exception
- a generic error
-
execute
public Long execute(long reportId, Map<String,Object> parameters, String sid, String username) throws Exception
Executes a custom report- Parameters:
reportId
- identifier of the custom reportparameters
- An optional map of parameters to be used inside the reportsid
- optional identifier of the current sessionusername
- username the user in whose name the method is run- Returns:
- the identifier of the output document
- Throws:
Exception
- a generic error
-
-