Package com.openkm.sdk4j.definition

Interface BaseReport

All Known Implementing Classes:

ReportImpl

public interface BaseReport

BaseReport

Author:

sochoa

Method Summary

Modifier and Type	Method	Description
InputStream	execute(long rpId, Map<String,String> params, String format, String uuid)	Execute report input stream.
InputStream	executeSql(long rpId)	Execute sql input stream.
String	generateDownloadReportToken(long rpId)	Generate download report token string.
Report	getReport(long rpId)	Gets report.
List<Report>	getReports(boolean active)	Gets reports.
List<SqlReport>	getSqlReports(boolean active)	Gets sql reports.
Document	save(long rpId, Map<String,String> params, String format, String dstId, String docName, String uuid)	Save report document.
Document	saveSql(long rpId, Map<String,String> params, String dstId, String docName)	Save sql document.

Method Details

getReports

List<Report> getReports(boolean active)
                 throws DatabaseException,
AccessDeniedException,
ParseException,
UnknownException,
WebserviceException

Gets reports.

Parameters:

active - the active

Returns:

the reports

Throws:

DatabaseException - the database exception

AccessDeniedException - the access denied exception

ParseException - the parse exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getReport

Report getReport(long rpId)
          throws DatabaseException,
AccessDeniedException,
ParseException,
UnknownException,
WebserviceException

Gets report.

Parameters:

rpId - the rp id

Returns:

the report

Throws:

DatabaseException - the database exception

AccessDeniedException - the access denied exception

ParseException - the parse exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

execute

InputStream execute(long rpId,
 Map<String,String> params,
 String format,
 String uuid)
             throws DatabaseException,
AccessDeniedException,
ParseException,
JRException,
EvalError,
UnknownException,
WebserviceException

Execute report input stream.

Parameters:

rpId - the rp id

params - the params

format - the format

uuid - the uuid

Returns:

the input stream

Throws:

DatabaseException - the database exception

AccessDeniedException - the access denied exception

ParseException - the parse exception

JRException - the jr exception

EvalError - the eval error

UnknownException - the unknown exception

WebserviceException - the webservice exception

executeSql

InputStream executeSql(long rpId)
                throws DatabaseException,
AccessDeniedException,
ParseException,
JRException,
EvalError,
UnknownException,
WebserviceException

Execute sql input stream.

Parameters:

rpId - the rp id

Returns:

the input stream

Throws:

DatabaseException - the database exception

AccessDeniedException - the access denied exception

ParseException - the parse exception

JRException - the jr exception

EvalError - the eval error

UnknownException - the unknown exception

WebserviceException - the webservice exception

save

Document save(long rpId,
 Map<String,String> params,
 String format,
 String dstId,
 String docName,
 String uuid)
       throws DatabaseException,
AccessDeniedException,
ParseException,
JRException,
EvalError,
UnknownException,
WebserviceException

Save report document.

Parameters:

rpId - the rp id

params - the params

format - the format

dstId - the dst id

docName - the doc name

uuid - the uuid

Returns:

the document

Throws:

DatabaseException - the database exception

AccessDeniedException - the access denied exception

ParseException - the parse exception

JRException - the jr exception

EvalError - the eval error

UnknownException - the unknown exception

WebserviceException - the webservice exception

saveSql

Document saveSql(long rpId,
 Map<String,String> params,
 String dstId,
 String docName)
          throws DatabaseException,
AccessDeniedException,
ParseException,
JRException,
EvalError,
UnknownException,
WebserviceException

Save sql document.

Parameters:

rpId - the rp id

params - the params

dstId - the dst id

docName - the doc name

Returns:

the document

Throws:

DatabaseException - the database exception

AccessDeniedException - the access denied exception

ParseException - the parse exception

JRException - the jr exception

EvalError - the eval error

UnknownException - the unknown exception

WebserviceException - the webservice exception

getSqlReports

List<SqlReport> getSqlReports(boolean active)
                       throws DatabaseException,
AccessDeniedException,
ParseException,
UnknownException,
WebserviceException

Gets sql reports.

Parameters:

active - the active

Returns:

the sql reports

Throws:

DatabaseException - the database exception

AccessDeniedException - the access denied exception

ParseException - the parse exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

generateDownloadReportToken

String generateDownloadReportToken(long rpId)
                            throws AccessDeniedException,
DatabaseException,
UnknownException,
WebserviceException

Generate download report token string.

Parameters:

rpId - the rp id

Returns:

the string

Throws:

AccessDeniedException - the access denied exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception