Package com.logicaldoc.report.webservice.soap.client

Class SoapReportClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<ReportService>

com.logicaldoc.report.webservice.soap.client.SoapReportClient

All Implemented Interfaces:

ReportService

public class SoapReportClient
extends com.logicaldoc.webservice.soap.client.SoapClient<ReportService>
implements ReportService

Java client to invoke the Report service

Since:

7.4

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapReportClient(String endpoint)

Method Summary

Modifier and Type	Method	Description
void	execute(String sid, long reportId, com.logicaldoc.webservice.model.WSAttribute[] parameters)	Executes a given report
WSReport[]	list(String sid)	Lists all the reports in the tenant

Methods inherited from class java.lang.Object

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

Constructor Details

SoapReportClient

public SoapReportClient(String endpoint)
                 throws IOException

Throws:

IOException

Method Details

list

public WSReport[] list(String sid)
                throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.core.security.authorization.PermissionException,
FeatureNotEnabledException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: ReportService

Lists all the reports in the tenant

Specified by:

list in interface ReportService

Parameters:

sid - The session identifier

Returns:

The array of all the reports

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions

FeatureNotEnabledException - The feature is not enabled in the license

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the data layer

execute

public void execute(String sid,
 long reportId,
 com.logicaldoc.webservice.model.WSAttribute[] parameters)
             throws com.logicaldoc.core.security.authorization.PermissionException,
com.logicaldoc.core.security.authentication.AuthenticationException,
FeatureNotEnabledException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: ReportService

Executes a given report

Specified by:

execute in interface ReportService

Parameters:

sid - The session identifier

reportId - The ID of the report to execute

parameters - The parameters to pass to the report (optional)

Throws:

com.logicaldoc.core.security.authorization.PermissionException - The user does not have enough permissions

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

FeatureNotEnabledException - The feature is not enabled in the license

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the data layer