org.kuali.kra.questionnaire.answer

Interface QuestionnaireAnswerService

All Known Implementing Classes:

QuestionnaireAnswerServiceImpl

public interface QuestionnaireAnswerService

This class defines the methods for questionnaire answer page. These methods should be module independent.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO
static String	YES

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkIfQuestionnaireIsActiveForModule(Integer questionnaireId, String coeusModuleCode, String coeusSubModuleCode) This method checks if the latest questionnaire instance associated with the given questionnaire ID is active and that it has the given module and sub-module codes in one of its usages.
List<AnswerHeader>	copyAnswerHeaders(ModuleQuestionnaireBean srcModuleQuestionnaireBean, ModuleQuestionnaireBean newModuleQuestionnaireBean) Copy all of the answer headers associated with a source ModuleQuestionnaireBean and associate them with a destination ModuleQuestionnaire Bean.
void	copyAnswerToNewVersion(AnswerHeader oldAnswerHeader, AnswerHeader newAnswerHeader) This method is to update questionnaire answers to new version and also copy the answers from the olld version if question is in not updated to new version.
List<AnswerHeader>	getAnswerHeadersForProtocol(ModuleQuestionnaireBean moduleQuestionnaireBean, String protocolNumber) This method is to get all the questionnaire answer for the protocol.
List<AnswerHeader>	getAnswerHeadersForProtocol(String protocolNumber) This method is to get all the questionnaire answer for the protocol.
ModuleQuestionnaireBean	getModuleSpecificBean(AnswerHeader answerHeader) Based on the data in the answer header, rebuild the module specific ModuleQuestionnaireBean.
ModuleQuestionnaireBean	getModuleSpecificBean(String moduleItemCode, String moduleItemKey, String moduleSubItemCode, String moduleSubItemKey, boolean finalDoc) Based on the moduleItemCode and moduleSubItemCode rebuilds the module specific ModuleQuestionnaireBean.
AnswerHeader	getNewVersionAnswerHeader(ModuleQuestionnaireBean moduleQuestionnaireBean, Questionnaire questionnaire) This method to create new questionnaire answer header for the new version questionnaire if user selected not to copy answers from old version.
List<AnswerHeader>	getNewVersionOfQuestionnaireAnswer(ModuleQuestionnaireBean moduleQuestionnaireBean) This method is to get a new version of existing questionnaire answer or set up the associate questionnaire answer for the module keys specified in ModuleQuestionnaireBean.
List<QuestionnaireUsage>	getPublishedQuestionnaire(ModuleQuestionnaireBean moduleQuestionnaireBean) Get the questionnaire usages for a module and submodule.
List<AnswerHeader>	getQuestionnaireAnswer(ModuleQuestionnaireBean moduleQuestionnaireBean) This method is to get existing questionnaire answer or set up the associate questionnaire answer for the module keys specified in ModuleQuestionnaireBean.
boolean	isQuestionnaireAnswerComplete(List<Answer> answers) check if the questionnaire is complete.
void	preSave(List<AnswerHeader> answerHeaders) This method is move answer for multiple answer question if needed and also update 'completed' flag.
void	setupChildAnswerIndicator(AnswerHeader answerHeader) This method update whether a child question is going to be displayed or hidden based on parent's answer and condition.
List<AnswerHeader>	versioningQuestionnaireAnswer(ModuleQuestionnaireBean moduleQuestionnaireBean, Integer sequenceNumber) This method is to copy questionnaire from old protocol to the new protocol version.

Field Detail

YES

static final String YES

See Also:

Constant Field Values

NO

static final String NO

See Also:

Constant Field Values

Method Detail

getQuestionnaireAnswer

List<AnswerHeader> getQuestionnaireAnswer(ModuleQuestionnaireBean moduleQuestionnaireBean)

This method is to get existing questionnaire answer or set up the associate questionnaire answer for the module keys specified in ModuleQuestionnaireBean.

Parameters:

moduleQuestionnaireBean -

Returns:

getNewVersionAnswerHeader

AnswerHeader getNewVersionAnswerHeader(ModuleQuestionnaireBean moduleQuestionnaireBean,
                                     Questionnaire questionnaire)

This method to create new questionnaire answer header for the new version questionnaire if user selected not to copy answers from old version.

Parameters:

moduleQuestionnaireBean -

questionnaire -

Returns:

copyAnswerToNewVersion

void copyAnswerToNewVersion(AnswerHeader oldAnswerHeader,
                          AnswerHeader newAnswerHeader)

This method is to update questionnaire answers to new version and also copy the answers from the olld version if question is in not updated to new version.

Parameters:

oldAnswerHeader -

newAnswerHeader -

versioningQuestionnaireAnswer

List<AnswerHeader> versioningQuestionnaireAnswer(ModuleQuestionnaireBean moduleQuestionnaireBean,
                                               Integer sequenceNumber)

This method is to copy questionnaire from old protocol to the new protocol version.

Parameters:

moduleQuestionnaireBean -

Returns:

preSave

void preSave(List<AnswerHeader> answerHeaders)

This method is move answer for multiple answer question if needed and also update 'completed' flag.

Parameters:

answerHeaders -

setupChildAnswerIndicator

void setupChildAnswerIndicator(AnswerHeader answerHeader)

This method update whether a child question is going to be displayed or hidden based on parent's answer and condition. This method is public is purely for 'lookup' question because js 'onchange' is not working when 'lookup' is used.

Parameters:

answers -

isQuestionnaireAnswerComplete

boolean isQuestionnaireAnswerComplete(List<Answer> answers)

check if the questionnaire is complete. This method...

Parameters:

answers -

Returns:

copyAnswerHeaders

List<AnswerHeader> copyAnswerHeaders(ModuleQuestionnaireBean srcModuleQuestionnaireBean,
                                   ModuleQuestionnaireBean newModuleQuestionnaireBean)

Copy all of the answer headers associated with a source ModuleQuestionnaireBean and associate them with a destination ModuleQuestionnaire Bean. This method persists the new AnswerHeader objects it creates.

Parameters:

srcModuleQuestionnaireBean - the ModulQuestionnaireBean containing the data pointing to the source questionnaires.

newModuleQuestionnaireBean - the ModuleQuestionnaireBean you would like to copy the AnswerHeader objects to.

Returns:

a list of AnswerHeader objects.

getAnswerHeadersForProtocol

List<AnswerHeader> getAnswerHeadersForProtocol(String protocolNumber)

This method is to get all the questionnaire answer for the protocol. Questionnaire answer may contain submit questionnaire, request submission questionnaire, amendment/renewal questionnaire.

Parameters:

protocolNumber -

Returns:

getAnswerHeadersForProtocol

List<AnswerHeader> getAnswerHeadersForProtocol(ModuleQuestionnaireBean moduleQuestionnaireBean,
                                             String protocolNumber)

This method is to get all the questionnaire answer for the protocol. Questionnaire answer may contain submit questionnaire, request submission questionnaire, amendment/renewal questionnaire.

Parameters:

moduleQuestionnaireBean -

protocolNumber -

Returns:

getPublishedQuestionnaire

List<QuestionnaireUsage> getPublishedQuestionnaire(ModuleQuestionnaireBean moduleQuestionnaireBean)

Get the questionnaire usages for a module and submodule.

Parameters:

coeusModule - the coeus module of the questionnaires you are looking for.

coeusSubModule - the coeus sub-module of the questionnaires you are looking for.

finalDoc -

Returns:

checkIfQuestionnaireIsActiveForModule

boolean checkIfQuestionnaireIsActiveForModule(Integer questionnaireId,
                                            String coeusModuleCode,
                                            String coeusSubModuleCode)

This method checks if the latest questionnaire instance associated with the given questionnaire ID is active and that it has the given module and sub-module codes in one of its usages.

Parameters:

questionnaireId -

coeusModule -

coeusSubModule -

Returns:

getModuleSpecificBean

ModuleQuestionnaireBean getModuleSpecificBean(AnswerHeader answerHeader)

Based on the data in the answer header, rebuild the module specific ModuleQuestionnaireBean. Assumes the document is in a final state.

Parameters:

answerHeader -

Returns:

getModuleSpecificBean

ModuleQuestionnaireBean getModuleSpecificBean(String moduleItemCode,
                                            String moduleItemKey,
                                            String moduleSubItemCode,
                                            String moduleSubItemKey,
                                            boolean finalDoc)

Based on the moduleItemCode and moduleSubItemCode rebuilds the module specific ModuleQuestionnaireBean.

Parameters:

moduleItemCode -

moduleItemKey -

moduleSubItemCode -

moduleSubItemKey -

finalDoc -

Returns:

getNewVersionOfQuestionnaireAnswer

List<AnswerHeader> getNewVersionOfQuestionnaireAnswer(ModuleQuestionnaireBean moduleQuestionnaireBean)

This method is to get a new version of existing questionnaire answer or set up the associate questionnaire answer for the module keys specified in ModuleQuestionnaireBean.

Parameters:

moduleQuestionnaireBean -

Returns: