com.openkm.sdk4j.impl

Class ReportImpl

java.lang.Object

com.openkm.sdk4j.impl.ClientImpl

com.openkm.sdk4j.impl.ReportImpl

All Implemented Interfaces:

BaseReport, Serializable

public class ReportImpl
extends ClientImpl
implements BaseReport, Serializable

Report

Author:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReportImpl(String host) ReportImpl

Method Summary

Modifier and Type	Method and Description
InputStream	executeReport(long rpId, Map<String,String> params, String format) Deprecated. As of sdk4j 3.14, replaced by executeReport(long, Map, String, String)
InputStream	executeReport(long rpId, Map<String,String> params, String format, String uuid) Execute report input stream.
String	generateDownloadReportToken(long rpId) Generate download report token string.
Report	getReport(long rpId) Gets report.
List<Report>	getReports(boolean active) Gets reports.
Document	saveReport(long rpId, Map<String,String> params, String format, String dstId, String docName) Deprecated. As of sdk4j 3.14, replaced by saveReport(long, Map, String, String, String, String)
Document	saveReport(long rpId, Map<String,String> params, String format, String dstId, String docName, String uuid) Save report document.
void	setAuthorizationToken(String authorizationToken) setAuthenticationToken

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

getClient, resource, resource

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportImpl

public ReportImpl(String host)

ReportImpl

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

getReports

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

Description copied from interface: BaseReport

Gets reports.

Specified by:

getReports in interface BaseReport

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

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

Description copied from interface: BaseReport

Gets report.

Specified by:

getReport in interface BaseReport

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

generateDownloadReportToken

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

Description copied from interface: BaseReport

Generate download report token string.

Specified by:

generateDownloadReportToken in interface BaseReport

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

executeReport

@Deprecated
public InputStream executeReport(long rpId,
                                             Map<String,String> params,
                                             String format)
                                      throws DatabaseException,
                                             AccessDeniedException,
                                             ParseException,
                                             JRException,
                                             EvalError,
                                             UnknownException,
                                             WebserviceException

Deprecated. As of sdk4j 3.14, replaced by executeReport(long, Map, String, String)

executeReport

Specified by:

executeReport in interface BaseReport

Parameters:

rpId - the rp id

params - the params

format - the format

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

See Also:

executeReport(long, Map, String, String)

executeReport

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

Description copied from interface: BaseReport

Execute report input stream.

Specified by:

executeReport in interface BaseReport

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

saveReport

@Deprecated
public Document saveReport(long rpId,
                                       Map<String,String> params,
                                       String format,
                                       String dstId,
                                       String docName)
                                throws DatabaseException,
                                       AccessDeniedException,
                                       ParseException,
                                       JRException,
                                       EvalError,
                                       UnknownException,
                                       WebserviceException

Deprecated. As of sdk4j 3.14, replaced by saveReport(long, Map, String, String, String, String)

saveReport

Specified by:

saveReport in interface BaseReport

Parameters:

rpId - the rp id

params - the params

format - the format

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

See Also:

saveReport(long, Map, String, String, String, String)

saveReport

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

Description copied from interface: BaseReport

Save report document.

Specified by:

saveReport in interface BaseReport

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