com.objectplanet.survey.plugin.interfaces

Interface IReport

public interface IReport

Interface for plugin report.
A class that implements this interface will be used to produce a whole report. The report name will be shown in the list of reports if it is available for the current survey. A user can access the report by clicking on the "view report" link:

Reports
Summary report	View report	Recalculate and view
Comment report	View report	Recalculate and view
My plugin report	View report

The url to the report is:
http://server-address/opinio/admin/viewReportPlugin.jsp?rp=X&sId=Y

where X is class name for the report and Y is id of the survey.

Author:

Irina Brun

Method Summary

Modifier and Type	Method and Description
boolean	availableForSurvey(long surveyId) Returns true if report is available for a survey
java.lang.String	getReportHTML(long surveyId) Gets the report html for a survey
java.lang.String	getReportName(long surveyId) Gets the report name.

Method Detail

getReportName

java.lang.String getReportName(long surveyId)

Gets the report name. This will be shown in the list of reports for a survey.

Parameters:

surveyId - Survey id

Returns:

The report name.

availableForSurvey

boolean availableForSurvey(long surveyId)

Returns true if report is available for a survey

Parameters:

surveyId - Survey id

Returns:

True if the class implementing this interface produce report for the spesified survey

getReportHTML

java.lang.String getReportHTML(long surveyId)

Gets the report html for a survey

Parameters:

surveyId - Survey id

Returns:

The report html