fi.techila.user

Interface ReportManager

public interface ReportManager

Report Manager interface.

Method Summary

Modifier and Type	Method and Description
void	addReportQuery(java.lang.String query, java.lang.String description) Add a report query.
java.lang.String	executeReportQuery(int id, java.util.Hashtable<java.lang.String,java.lang.String> pparams, boolean headers, boolean xml, java.lang.String separator) Execute a report query.
java.util.Vector<java.util.Hashtable<java.lang.String,java.lang.String>>	getReportQueries() Get a list of available reports.
void	removeReportQuery(int id) Remove a report query.
void	setReportQuery(int id, java.lang.String query, java.lang.String description) Modify a pre-existing report.

Method Detail

getReportQueries

java.util.Vector<java.util.Hashtable<java.lang.String,java.lang.String>> getReportQueries()
                                                                                   throws java.lang.Exception

Get a list of available reports.

Returns:

Throws:

java.lang.Exception

addReportQuery

void addReportQuery(java.lang.String query,
                    java.lang.String description)
             throws java.lang.Exception

Add a report query.

Parameters:

query - The SQL query

description -

Throws:

java.lang.Exception

setReportQuery

void setReportQuery(int id,
                    java.lang.String query,
                    java.lang.String description)
             throws java.lang.Exception

Modify a pre-existing report.

Parameters:

id - The report to modify.

query - the new SQL query

description -

Throws:

java.lang.Exception

removeReportQuery

void removeReportQuery(int id)
                throws java.lang.Exception

Remove a report query.

Parameters:

id -

Throws:

java.lang.Exception

executeReportQuery

java.lang.String executeReportQuery(int id,
                                    java.util.Hashtable<java.lang.String,java.lang.String> pparams,
                                    boolean headers,
                                    boolean xml,
                                    java.lang.String separator)
                             throws java.lang.Exception

Execute a report query.

Parameters:

id - Id of the report to execute

pparams - possible parameters for the report

headers - Print headers of the report

xml - Output XML

separator - separator character for non-XMl reports

Returns:

the report as a string

Throws:

java.lang.Exception