org.jasig.portlet.survey.service.report

Interface ISurveyReportMapper

All Known Implementing Classes:

SurveyReportMapperImpl

public interface ISurveyReportMapper

This interface defines the contract through which the REST API knows which ISurveyReportGenerator to use for a specific survey. The 'report' is the screen that appears when a user completes a survey and submits his answers (a.k.a. the 'Response'). Reports for responses submitted in the past may be re-generated and re-displayed.

Author:

drewwills

Method Summary

Modifier and Type	Method and Description
ISurveyReportGenerator	getReportGenerator(SurveyDTO survey) Provides the one instance of ISurveyReportGenerator mapped to the survey with the specified cannonicalName.

Method Detail

getReportGenerator

ISurveyReportGenerator getReportGenerator(SurveyDTO survey)

Provides the one instance of ISurveyReportGenerator mapped to the survey with the specified cannonicalName. This method will never return null; there is a DefaultSurveyReportGenerator that merely thanks the user for his response.

Parameters:

survey - The survey instance for which a generator is needed

Returns:

A working instance of ISurveyReportGenerator; never null.