Package com.logicaldoc.gui.frontend.client.services

Interface ReportService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

@RemoteServiceRelativePath("report")
public interface ReportService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Report Service. This service gives all needed methods to handle reports.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ReportService.Instance

Method Summary

Modifier and Type	Method	Description
void	changeStatus(long id, boolean enabled)	Changes a report enabled/disabled status
GUIReport	create(GUIReport report)	Creates a new report
void	delete(long id)	Deletes a given report
void	execute(long id, GUIAttribute[] parameters)	Processes a report
GUIReport	getReport(long id, boolean withLog)	Loads a given report from the database
GUIAttribute[]	getReportParameters(long id)	Loads the attributes defined in the given report
GUIReport[]	getReports()	Loads all the reports
GUIReport	save(GUIReport report)	Updates a report
void	storeUploadedDesign(long id)	Store the uploaded design file in the given report

Method Detail

delete

void delete(long id)
     throws ServerException

Deletes a given report

Parameters:

id - identifier of the report to delete

Throws:

ServerException - an error happened in the server application

save

GUIReport save(GUIReport report)
        throws ServerException

Updates a report

Parameters:

report - the report to save

Returns:

the saved report

Throws:

ServerException - an error happened in the server application

storeUploadedDesign

void storeUploadedDesign(long id)
                  throws ServerException

Store the uploaded design file in the given report

Parameters:

id - identifier of the report

Throws:

ServerException - an error happened in the server application

create

GUIReport create(GUIReport report)
          throws ServerException

Creates a new report

Parameters:

report - the report to create

Returns:

the just created report

Throws:

ServerException - an error happened in the server application

getReport

GUIReport getReport(long id,
                    boolean withLog)
             throws ServerException

Loads a given report from the database

Parameters:

id - identifier of the records

withLog - flag to ask for the logs

Returns:

the report retrieved by the server application

Throws:

ServerException - an error happened in the server application

getReports

GUIReport[] getReports()
                throws ServerException

Loads all the reports

Returns:

all the available reports

Throws:

ServerException - an error happened in the server application

getReportParameters

GUIAttribute[] getReportParameters(long id)
                            throws ServerException

Loads the attributes defined in the given report

Parameters:

id - identifiers of the report

Returns:

the parameters of the report

Throws:

ServerException - an error happened in the server application

changeStatus

void changeStatus(long id,
                  boolean enabled)
           throws ServerException

Changes a report enabled/disabled status

Parameters:

id - identifier of the report

enabled - the new enabled status

Throws:

ServerException - an error happened in the server application

execute

void execute(long id,
             GUIAttribute[] parameters)
      throws ServerException

Processes a report

Parameters:

id - identifier of the report

parameters - the values to be used in generating the report

Throws:

ServerException - an error happened in the server application