org.kuali.kra.protocol.questionnaire

Class ProtocolQuestionnaireAuditRuleBase

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.questionnaire.BaseQuestionnaireAuditRule<ProtocolDocumentBase>

org.kuali.kra.protocol.questionnaire.ProtocolQuestionnaireAuditRuleBase

All Implemented Interfaces:

org.kuali.rice.krad.rules.rule.AddAdHocRoutePersonRule, org.kuali.rice.krad.rules.rule.AddAdHocRouteWorkgroupRule, org.kuali.rice.krad.rules.rule.AddNoteRule, org.kuali.rice.krad.rules.rule.ApproveDocumentRule, org.kuali.rice.krad.rules.rule.BusinessRule, org.kuali.rice.krad.rules.rule.CompleteDocumentRule, org.kuali.rice.krad.rules.rule.DocumentAuditRule, org.kuali.rice.krad.rules.rule.RouteDocumentRule, org.kuali.rice.krad.rules.rule.SaveDocumentRule, org.kuali.rice.krad.rules.rule.SendAdHocRequestsRule

Direct Known Subclasses:

IacucProtocolQuestionnaireAuditRule

public abstract class ProtocolQuestionnaireAuditRuleBase
extends BaseQuestionnaireAuditRule<ProtocolDocumentBase>
implements org.kuali.rice.krad.rules.rule.DocumentAuditRule

Field Summary

Fields inherited from class org.kuali.kra.rules.ResearchDocumentRuleBase

CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME, DOCUMENT_ERROR_PATH, VALIDATION_REQUIRED

Constructor Summary

Constructors

Constructor and Description
ProtocolQuestionnaireAuditRuleBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addErrorToAuditErrors(Integer answerHeaderIndex, QuestionnaireUsage usage, String errorKey, String messageKey) Creates and adds the Audit Error to the List auditError.
protected void	addMandatoryQuestionnaireErrorToAuditErrors(Integer answerHeaderIndex, QuestionnaireUsage usage)
protected void	addQuestionnaireNotUpdatedErrorToAuditErrors(Integer answerHeaderIndex, QuestionnaireUsage usage)
protected String	getAuditErrorLink()
protected String	getAuditErrorsLabel()
protected List<Integer>	getIncompleteMandatoryQuestionnaire(ProtocolDocumentBase protocolDocument)
protected abstract String	getModuleCodeHook()
protected abstract ProtocolModuleQuestionnaireBeanBase	getProtocolModuleQuestionnaireBean(ProtocolBase protocol)
protected abstract ProtocolModuleQuestionnaireBeanBase	getProtocolModuleQuestionnaireBean(String moduleItemCode, String moduleItemKey, String moduleSubItemCode, String moduleSubItemKey, boolean finalDoc)
protected QuestionnaireAnswerService	getQuestionnaireAnswerService() Creates and adds the AuditCluster to the Global AuditErrorMap.
protected abstract String	getQuestionnaireModuleCodeHook()
boolean	isMandatorySubmissionQuestionnaireComplete(List<AnswerHeader> answerHeaders)
boolean	isRequestSubmission()
boolean	processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)
void	setRequestSubmittion(boolean requestSubmission)

Methods inherited from class org.kuali.kra.questionnaire.BaseQuestionnaireAuditRule

addErrorToAuditErrors, getIncompleteMandatoryQuestionnaire, getQuestionnaireUsage, reportAndCreateAuditCluster

Methods inherited from class org.kuali.kra.rules.ResearchDocumentRuleBase

addAuditError, getBusinessObjectService, getErrorReporter, getKnsDictionaryValidationService, getParameterService, getSoftErrors, hasPermission, hasPermission, hasRole, hasRole, isInvalid, isValid, keyValue, processBudgetVersionsBusinessRule, reportError, reportErrorWithoutFullErrorPath, reportSoftError, reportWarning, setBusinessObjectService, setParameterService

Methods inherited from class org.kuali.rice.krad.rules.DocumentRuleBase

buildDocumentTypeActionRequestPermissionDetails, buildDocumentTypePermissionDetails, getDataDictionaryService, getDictionaryValidationService, getDocumentDictionaryService, getGroupService, getKualiConfigurationService, getMaxDictionaryValidationDepth, getPermissionService, getPersonService, hasAdHocRouteCompletion, isAddHocRoutePersonValid, isAddHocRouteWorkgroupValid, isAdHocRouteCompletionToInitiator, isAdHocRouteRecipientsValid, isDocumentAttributesValid, isDocumentOverviewValid, isNoteValid, processAddAdHocRoutePerson, processAddAdHocRouteWorkgroup, processAddNote, processApproveDocument, processCompleteDocument, processCustomAddAdHocRoutePersonBusinessRules, processCustomAddAdHocRouteWorkgroupBusinessRules, processCustomAddNoteBusinessRules, processCustomApproveDocumentBusinessRules, processCustomCompleteDocumentBusinessRules, processCustomRouteDocumentBusinessRules, processCustomSaveDocumentBusinessRules, processCustomSendAdHocRequests, processRouteDocument, processSaveDocument, processSendAdHocRequests, setDocumentDictionaryService, setMaxDictionaryValidationDepth, useKimPermission, validateSensitiveDataValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtocolQuestionnaireAuditRuleBase

public ProtocolQuestionnaireAuditRuleBase()

Method Detail

processRunAuditBusinessRules

public boolean processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)

Specified by:

processRunAuditBusinessRules in interface org.kuali.rice.krad.rules.rule.DocumentAuditRule

Overrides:

processRunAuditBusinessRules in class BaseQuestionnaireAuditRule<ProtocolDocumentBase>

getIncompleteMandatoryQuestionnaire

protected List<Integer> getIncompleteMandatoryQuestionnaire(ProtocolDocumentBase protocolDocument)

Specified by:

getIncompleteMandatoryQuestionnaire in class BaseQuestionnaireAuditRule<ProtocolDocumentBase>

addQuestionnaireNotUpdatedErrorToAuditErrors

protected void addQuestionnaireNotUpdatedErrorToAuditErrors(Integer answerHeaderIndex,
                                                QuestionnaireUsage usage)

addMandatoryQuestionnaireErrorToAuditErrors

protected void addMandatoryQuestionnaireErrorToAuditErrors(Integer answerHeaderIndex,
                                               QuestionnaireUsage usage)

addErrorToAuditErrors

protected void addErrorToAuditErrors(Integer answerHeaderIndex,
                         QuestionnaireUsage usage,
                         String errorKey,
                         String messageKey)

Creates and adds the Audit Error to the List auditError.

isMandatorySubmissionQuestionnaireComplete

public boolean isMandatorySubmissionQuestionnaireComplete(List<AnswerHeader> answerHeaders)

getQuestionnaireAnswerService

protected QuestionnaireAnswerService getQuestionnaireAnswerService()

Creates and adds the AuditCluster to the Global AuditErrorMap.

Overrides:

getQuestionnaireAnswerService in class BaseQuestionnaireAuditRule<ProtocolDocumentBase>

getAuditErrorLink

protected String getAuditErrorLink()

Specified by:

getAuditErrorLink in class BaseQuestionnaireAuditRule<ProtocolDocumentBase>

getAuditErrorsLabel

protected String getAuditErrorsLabel()

Specified by:

getAuditErrorsLabel in class BaseQuestionnaireAuditRule<ProtocolDocumentBase>

isRequestSubmission

public boolean isRequestSubmission()

setRequestSubmittion

public void setRequestSubmittion(boolean requestSubmission)

getModuleCodeHook

protected abstract String getModuleCodeHook()

getProtocolModuleQuestionnaireBean

protected abstract ProtocolModuleQuestionnaireBeanBase getProtocolModuleQuestionnaireBean(ProtocolBase protocol)

getProtocolModuleQuestionnaireBean

protected abstract ProtocolModuleQuestionnaireBeanBase getProtocolModuleQuestionnaireBean(String moduleItemCode,
                                                                     String moduleItemKey,
                                                                     String moduleSubItemCode,
                                                                     String moduleSubItemKey,
                                                                     boolean finalDoc)

getQuestionnaireModuleCodeHook

protected abstract String getQuestionnaireModuleCodeHook()