org.kuali.kra.iacuc

Class IacucProtocolDocumentRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.protocol.ProtocolDocumentRuleBase<IacucCommitteeDecision>

org.kuali.kra.iacuc.IacucProtocolDocumentRule

All Implemented Interfaces:

IacucProtocolAssignCmtRule, IacucProtocolModifySubmissionRule, AddProtocolExceptionRule, AddProtocolSpeciesRule, ExecuteCommitteeDecisionAbstainerRule<IacucCommitteeDecision>, ExecuteCommitteeDecisionRecuserRule<IacucCommitteeDecision>, ExecuteCommitteeDecisionRule<IacucCommitteeDecision>, ExecuteProtocolSubmitActionRule, AddProtocolAttachmentPersonnelRule, AddProtocolUnitRule, AddProtocolLocationRule, AddProtocolReferenceRule, BusinessRuleInterface, 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

public class IacucProtocolDocumentRule
extends ProtocolDocumentRuleBase<IacucCommitteeDecision>
implements AddProtocolSpeciesRule, AddProtocolExceptionRule, IacucProtocolAssignCmtRule, IacucProtocolModifySubmissionRule

Main Business Rule class for IacucProtocolDocument. Responsible for delegating rules to independent rule classes.

Author:

Kuali Nervous System Team (kualidev@oncourse.iu.edu)

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
IacucProtocolDocumentRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected Set<String>	getDistinctSpeciesGroups(List<IacucProtocolSpecies> speciesList) This method is to get a distinct list of species group configured.
protected Set<Integer>	getDistinctSpeciesList(List<IacucProtocolSpecies> speciesList) This method is to get a disctinct list of species configured.
protected String	getInProgressProtocolStatusCodeHook()
protected ProtocolFundingSourceAuditRuleBase	getNewProtocolFundingSourceAuditRuleInstanceHook()
protected ProtocolFundingSourceRuleBase	getNewProtocolFundingSourceRuleInstanceHook()
protected ProtocolLocationRuleBase	getNewProtocolLocationRuleInstanceHook()
protected ProtocolPersonnelAuditRuleBase	getNewProtocolPersonnelAuditRuleInstanceHook()
protected IacucProtocolReferenceRule	getNewProtocolReferenceRuleInstanceHook()
protected ProtocolResearchAreaAuditRuleBase	getNewProtocolResearchAreaAuditRuleInstanceHook()
protected ProtocolUnitRuleBase	getNewProtocolUnitRuleInstanceHook()
ProtocolAttachmentPersonnelRuleBase	getProtocolAttachmentPersonnelRuleInstanceHook()
protected KraDocumentEventBaseExtension	getSaveProtocolPersonnelEventHook(ProtocolDocumentBase document)
protected boolean	isProtocolExceptionValid(List<IacucProtocolException> protocolExceptions, Set<Integer> protocolSpecies) This method is to check if list species used in exception are valid
protected boolean	isProtocolProcedureSpeciesGroupValid(List<IacucProtocolStudyGroupBean> protocolStudyGroups, Set<String> protocolSpeciesGroups) This method is to check if list species groups used for procedures are valid
protected boolean	isProtocolProcedureValid(List<IacucProtocolStudyGroupBean> protocolStudyGroups, Set<Integer> protocolSpecies) This method is to check if list species used for procedures are valid
protected ExecuteCommitteeDecisionAbstainerRule<IacucCommitteeDecision>	newCommitteeDecisionAbstainerRuleInstanceHook()
protected ExecuteCommitteeDecisionRecuserRule<IacucCommitteeDecision>	newCommitteeDecisionRecuserRuleInstanceHook()
protected IacucCommitteeDecisionRule	newCommitteeDecisionRuleInstanceHook()
protected ProtocolSubmitActionRuleBase	newProtocolSubmitActionRuleInstanceHook()
protected SubmitProtocolAttachmentProtocolRuleImplBase	newSubmitProtocolAttachmentProtocolRuleImplInstanceHook()
boolean	processAddProtocolExceptionBusinessRules(AddProtocolExceptionEvent addProtocolExceptionEvent) This method evaluates to true if ProtocolException objects satisfy required fields and business rules.
boolean	processAddProtocolSpeciesBusinessRules(AddProtocolSpeciesEvent addProtocolSpeciesEvent) This method evaluates to true if ProtocolSpecies objects satisfy required fields and business rules.
boolean	processAssignToCommittee(ProtocolDocumentBase document, IacucProtocolAssignCmtBean actionBean)
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processModifySubmissionRule(ProtocolDocumentBase document, IacucProtocolModifySubmissionBean actionBean)
boolean	processProtocolSpeciesRules(IacucProtocolDocument document) This method is to validate protocol species defined and its references.

Methods inherited from class org.kuali.kra.protocol.ProtocolDocumentRuleBase

proccessCommitteeDecisionAbstainerRule, proccessCommitteeDecisionRecuserRule, proccessCommitteeDecisionRule, processAddPermissionsUserBusinessRules, processAddProtocolAttachmentPersonnelRules, processAddProtocolFundingSourceBusinessRules, processAddProtocolLocationBusinessRules, processAddProtocolReferenceBusinessRules, processAddProtocolUnitBusinessRules, processCustomRouteDocumentBusinessRules, processLeadUnitBusinessRules, processProtocolLocationBusinessRules, processProtocolResearchAreaBusinessRules, processRules, processRunAuditBusinessRules, processSubmitAction

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, 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

IacucProtocolDocumentRule

public IacucProtocolDocumentRule()

Method Detail

processCustomSaveDocumentBusinessRules

protected boolean processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)

Overrides:

processCustomSaveDocumentBusinessRules in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

processProtocolSpeciesRules

public boolean processProtocolSpeciesRules(IacucProtocolDocument document)

This method is to validate protocol species defined and its references. Protocol species are first defined in species/groups and these species/groups are used in exception and procedure tabs. We need to make sure the dependency exist if user tries to remove/modify existing species/groups once exception and procedures are defined.

Parameters:

document -

Returns:

isProtocolExceptionValid

protected boolean isProtocolExceptionValid(List<IacucProtocolException> protocolExceptions,
                               Set<Integer> protocolSpecies)

This method is to check if list species used in exception are valid

Parameters:

protocolExceptions -

protocolSpecies -

Returns:

isProtocolProcedureValid

protected boolean isProtocolProcedureValid(List<IacucProtocolStudyGroupBean> protocolStudyGroups,
                               Set<Integer> protocolSpecies)

This method is to check if list species used for procedures are valid

Parameters:

protocolStudyGroups -

protocolSpecies -

Returns:

getDistinctSpeciesList

protected Set<Integer> getDistinctSpeciesList(List<IacucProtocolSpecies> speciesList)

This method is to get a disctinct list of species configured.

Parameters:

speciesList -

Returns:

getDistinctSpeciesGroups

protected Set<String> getDistinctSpeciesGroups(List<IacucProtocolSpecies> speciesList)

This method is to get a distinct list of species group configured.

Parameters:

speciesList -

Returns:

isProtocolProcedureSpeciesGroupValid

protected boolean isProtocolProcedureSpeciesGroupValid(List<IacucProtocolStudyGroupBean> protocolStudyGroups,
                                           Set<String> protocolSpeciesGroups)

This method is to check if list species groups used for procedures are valid

Parameters:

protocolStudyGroups -

protocolSpeciesGroups -

Returns:

getInProgressProtocolStatusCodeHook

protected String getInProgressProtocolStatusCodeHook()

Specified by:

getInProgressProtocolStatusCodeHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

getNewProtocolResearchAreaAuditRuleInstanceHook

protected ProtocolResearchAreaAuditRuleBase getNewProtocolResearchAreaAuditRuleInstanceHook()

Specified by:

getNewProtocolResearchAreaAuditRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

processAddProtocolSpeciesBusinessRules

public boolean processAddProtocolSpeciesBusinessRules(AddProtocolSpeciesEvent addProtocolSpeciesEvent)

Description copied from interface: AddProtocolSpeciesRule

This method evaluates to true if ProtocolSpecies objects satisfy required fields and business rules.

Specified by:

processAddProtocolSpeciesBusinessRules in interface AddProtocolSpeciesRule

Returns:

boolean true for valid object and false for invalid entry

processAddProtocolExceptionBusinessRules

public boolean processAddProtocolExceptionBusinessRules(AddProtocolExceptionEvent addProtocolExceptionEvent)

Description copied from interface: AddProtocolExceptionRule

This method evaluates to true if ProtocolException objects satisfy required fields and business rules.

Specified by:

processAddProtocolExceptionBusinessRules in interface AddProtocolExceptionRule

Returns:

boolean true for valid object and false for invalid entry

getNewProtocolReferenceRuleInstanceHook

protected IacucProtocolReferenceRule getNewProtocolReferenceRuleInstanceHook()

Specified by:

getNewProtocolReferenceRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

getSaveProtocolPersonnelEventHook

protected KraDocumentEventBaseExtension getSaveProtocolPersonnelEventHook(ProtocolDocumentBase document)

Specified by:

getSaveProtocolPersonnelEventHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

getNewProtocolPersonnelAuditRuleInstanceHook

protected ProtocolPersonnelAuditRuleBase getNewProtocolPersonnelAuditRuleInstanceHook()

Specified by:

getNewProtocolPersonnelAuditRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

getNewProtocolUnitRuleInstanceHook

protected ProtocolUnitRuleBase getNewProtocolUnitRuleInstanceHook()

Specified by:

getNewProtocolUnitRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

newProtocolSubmitActionRuleInstanceHook

protected ProtocolSubmitActionRuleBase newProtocolSubmitActionRuleInstanceHook()

Specified by:

newProtocolSubmitActionRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

getNewProtocolLocationRuleInstanceHook

protected ProtocolLocationRuleBase getNewProtocolLocationRuleInstanceHook()

Specified by:

getNewProtocolLocationRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

getNewProtocolFundingSourceAuditRuleInstanceHook

protected ProtocolFundingSourceAuditRuleBase getNewProtocolFundingSourceAuditRuleInstanceHook()

Specified by:

getNewProtocolFundingSourceAuditRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

getNewProtocolFundingSourceRuleInstanceHook

protected ProtocolFundingSourceRuleBase getNewProtocolFundingSourceRuleInstanceHook()

Specified by:

getNewProtocolFundingSourceRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

processAssignToCommittee

public boolean processAssignToCommittee(ProtocolDocumentBase document,
                               IacucProtocolAssignCmtBean actionBean)

Specified by:

processAssignToCommittee in interface IacucProtocolAssignCmtRule

getProtocolAttachmentPersonnelRuleInstanceHook

public ProtocolAttachmentPersonnelRuleBase getProtocolAttachmentPersonnelRuleInstanceHook()

Specified by:

getProtocolAttachmentPersonnelRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

newSubmitProtocolAttachmentProtocolRuleImplInstanceHook

protected SubmitProtocolAttachmentProtocolRuleImplBase newSubmitProtocolAttachmentProtocolRuleImplInstanceHook()

Specified by:

newSubmitProtocolAttachmentProtocolRuleImplInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

processModifySubmissionRule

public boolean processModifySubmissionRule(ProtocolDocumentBase document,
                                  IacucProtocolModifySubmissionBean actionBean)

Specified by:

processModifySubmissionRule in interface IacucProtocolModifySubmissionRule

newCommitteeDecisionRuleInstanceHook

protected IacucCommitteeDecisionRule newCommitteeDecisionRuleInstanceHook()

Specified by:

newCommitteeDecisionRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

newCommitteeDecisionAbstainerRuleInstanceHook

protected ExecuteCommitteeDecisionAbstainerRule<IacucCommitteeDecision> newCommitteeDecisionAbstainerRuleInstanceHook()

Specified by:

newCommitteeDecisionAbstainerRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>

newCommitteeDecisionRecuserRuleInstanceHook

protected ExecuteCommitteeDecisionRecuserRule<IacucCommitteeDecision> newCommitteeDecisionRecuserRuleInstanceHook()

Specified by:

newCommitteeDecisionRecuserRuleInstanceHook in class ProtocolDocumentRuleBase<IacucCommitteeDecision>