org.kuali.kra.protocol

Class ProtocolDocumentRuleBase<CD extends CommitteeDecision<? extends CommitteePersonBase>>

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

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

All Implemented Interfaces:

ExecuteCommitteeDecisionAbstainerRule<CD>, ExecuteCommitteeDecisionRecuserRule<CD>, ExecuteCommitteeDecisionRule<CD>, 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

Direct Known Subclasses:

IacucProtocolDocumentRule, ProtocolDocumentRule

public abstract class ProtocolDocumentRuleBase<CD extends CommitteeDecision<? extends CommitteePersonBase>>
extends ResearchDocumentRuleBase
implements AddProtocolReferenceRule, AddProtocolLocationRule, AddProtocolAttachmentPersonnelRule, AddProtocolUnitRule, BusinessRuleInterface, ExecuteProtocolSubmitActionRule, ExecuteCommitteeDecisionRule<CD>, ExecuteCommitteeDecisionAbstainerRule<CD>, ExecuteCommitteeDecisionRecuserRule<CD>

Main Business Rule class for ProtocolDocumentBase. 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
ProtocolDocumentRuleBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	getInProgressProtocolStatusCodeHook()
protected abstract ProtocolFundingSourceAuditRuleBase	getNewProtocolFundingSourceAuditRuleInstanceHook()
protected abstract ProtocolFundingSourceRuleBase	getNewProtocolFundingSourceRuleInstanceHook()
protected abstract ProtocolLocationRuleBase	getNewProtocolLocationRuleInstanceHook()
protected abstract ProtocolPersonnelAuditRuleBase	getNewProtocolPersonnelAuditRuleInstanceHook()
protected abstract ProtocolReferenceRuleBase	getNewProtocolReferenceRuleInstanceHook()
protected abstract ProtocolResearchAreaAuditRuleBase	getNewProtocolResearchAreaAuditRuleInstanceHook()
protected abstract ProtocolUnitRuleBase	getNewProtocolUnitRuleInstanceHook()
abstract ProtocolAttachmentPersonnelRuleBase	getProtocolAttachmentPersonnelRuleInstanceHook()
protected abstract KraDocumentEventBaseExtension	getSaveProtocolPersonnelEventHook(ProtocolDocumentBase document)
protected abstract ExecuteCommitteeDecisionAbstainerRule<CD>	newCommitteeDecisionAbstainerRuleInstanceHook()
protected abstract ExecuteCommitteeDecisionRecuserRule<CD>	newCommitteeDecisionRecuserRuleInstanceHook()
protected abstract CommitteeDecisionRuleBase<CD>	newCommitteeDecisionRuleInstanceHook()
protected abstract ExecuteProtocolSubmitActionRule	newProtocolSubmitActionRuleInstanceHook()
protected abstract SubmitProtocolAttachmentProtocolRuleImplBase	newSubmitProtocolAttachmentProtocolRuleImplInstanceHook()
boolean	proccessCommitteeDecisionAbstainerRule(ProtocolDocumentBase document, CD actionBean) This method...
boolean	proccessCommitteeDecisionRecuserRule(ProtocolDocumentBase document, CD actionBean) This method...
boolean	proccessCommitteeDecisionRule(ProtocolDocumentBase document, CD actionBean) This method will check for valid user input and attach error message to fields as needed.
boolean	processAddPermissionsUserBusinessRules(org.kuali.rice.krad.document.Document document, List<User> users, PermissionsUser newUser)
boolean	processAddProtocolAttachmentPersonnelRules(AddProtocolAttachmentPersonnelEvent addProtocolAttachmentPersonnelEvent) This method evaluates to true if ProtocolAttachmentPersonnelBase object satisfy required fields and business rules.
boolean	processAddProtocolFundingSourceBusinessRules(AddProtocolFundingSourceEventBase addProtocolFundingSourceEvent)
boolean	processAddProtocolLocationBusinessRules(AddProtocolLocationEvent addProtocolLocationEvent) This method evaluates to true if ProtocolLocationBase objects satisfy required fields and business rules.
boolean	processAddProtocolReferenceBusinessRules(AddProtocolReferenceEventBase addProtocolReferenceEvent) This method evaluates to true if ProcotcolReference objects satisfy required fields and business rules.
boolean	processAddProtocolUnitBusinessRules(AddProtocolUnitEvent addProtocolUnitEvent) This method evaluates to true if ProtocolUnitBase objects satisfy required fields and business rules.
protected boolean	processCustomRouteDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processLeadUnitBusinessRules(ProtocolDocumentBase document) Validates lead unit rules for a ProtocolDocumentBase.
boolean	processProtocolLocationBusinessRules(ProtocolDocumentBase document) At least one organization must be entered.
boolean	processProtocolResearchAreaBusinessRules(ProtocolDocumentBase document) This method will check if all the research areas that have been added to the protocol are indeed active.
boolean	processRules(KraDocumentEventBaseExtension event) This method implementer must process rule for the event passed.
boolean	processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processSubmitAction(ProtocolDocumentBase document, ProtocolSubmitAction submitAction)

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

ProtocolDocumentRuleBase

public ProtocolDocumentRuleBase()

Method Detail

processCustomRouteDocumentBusinessRules

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

Overrides:

processCustomRouteDocumentBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

processCustomSaveDocumentBusinessRules

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

Overrides:

processCustomSaveDocumentBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

getInProgressProtocolStatusCodeHook

protected abstract String getInProgressProtocolStatusCodeHook()

processProtocolResearchAreaBusinessRules

public boolean processProtocolResearchAreaBusinessRules(ProtocolDocumentBase document)

This method will check if all the research areas that have been added to the protocol are indeed active.

Parameters:

document -

Returns:

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 ResearchDocumentRuleBase

See Also:

org.kuali.core.rule.DocumentAuditRule#processRunAuditBusinessRules(org.kuali.rice.krad.document.Document)

getNewProtocolFundingSourceAuditRuleInstanceHook

protected abstract ProtocolFundingSourceAuditRuleBase getNewProtocolFundingSourceAuditRuleInstanceHook()

getNewProtocolPersonnelAuditRuleInstanceHook

protected abstract ProtocolPersonnelAuditRuleBase getNewProtocolPersonnelAuditRuleInstanceHook()

getNewProtocolResearchAreaAuditRuleInstanceHook

protected abstract ProtocolResearchAreaAuditRuleBase getNewProtocolResearchAreaAuditRuleInstanceHook()

processLeadUnitBusinessRules

public boolean processLeadUnitBusinessRules(ProtocolDocumentBase document)

Validates lead unit rules for a ProtocolDocumentBase.

Parameters:

document - the document

Returns:

true if validation passes false if not

Throws:

NullPointerException - if the document is null

processProtocolLocationBusinessRules

public boolean processProtocolLocationBusinessRules(ProtocolDocumentBase document)

At least one organization must be entered. If the default value is removed, another organization must be added before user can save

See Also:

org.kuali.kra.irb.rule.SaveProtocolLocationRule#processSaveProtocolLocationBusinessRules(org.kuali.kra.irb.rule.event.SaveProtocolLocationEvent)

getSaveProtocolPersonnelEventHook

protected abstract KraDocumentEventBaseExtension getSaveProtocolPersonnelEventHook(ProtocolDocumentBase document)

processAddProtocolReferenceBusinessRules

public boolean processAddProtocolReferenceBusinessRules(AddProtocolReferenceEventBase addProtocolReferenceEvent)

Description copied from interface: AddProtocolReferenceRule

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

Specified by:

processAddProtocolReferenceBusinessRules in interface AddProtocolReferenceRule

Returns:

boolean true for valid object and false for invalid entry

getNewProtocolReferenceRuleInstanceHook

protected abstract ProtocolReferenceRuleBase getNewProtocolReferenceRuleInstanceHook()

processAddProtocolLocationBusinessRules

public boolean processAddProtocolLocationBusinessRules(AddProtocolLocationEvent addProtocolLocationEvent)

Description copied from interface: AddProtocolLocationRule

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

Specified by:

processAddProtocolLocationBusinessRules in interface AddProtocolLocationRule

Returns:

boolean true for valid object and false for invalid entry

See Also:

AddProtocolLocationRule.processAddProtocolLocationBusinessRules(org.kuali.kra.irb.protocol.location.AddProtocolLocationEvent)

getNewProtocolLocationRuleInstanceHook

protected abstract ProtocolLocationRuleBase getNewProtocolLocationRuleInstanceHook()

processAddProtocolFundingSourceBusinessRules

public boolean processAddProtocolFundingSourceBusinessRules(AddProtocolFundingSourceEventBase addProtocolFundingSourceEvent)

See Also:

org.kuali.kra.irb.protocol.AddProtocolFundingSourceRule#processAddProtocolFundingSourceBusinessRules(org.org.kuali.kra.irb.protocol.funding.AddProtocolFundingSourceEventBase)

getNewProtocolFundingSourceRuleInstanceHook

protected abstract ProtocolFundingSourceRuleBase getNewProtocolFundingSourceRuleInstanceHook()

processAddPermissionsUserBusinessRules

public boolean processAddPermissionsUserBusinessRules(org.kuali.rice.krad.document.Document document,
                                             List<User> users,
                                             PermissionsUser newUser)

processAddProtocolAttachmentPersonnelRules

public boolean processAddProtocolAttachmentPersonnelRules(AddProtocolAttachmentPersonnelEvent addProtocolAttachmentPersonnelEvent)

Description copied from interface: AddProtocolAttachmentPersonnelRule

This method evaluates to true if ProtocolAttachmentPersonnelBase object satisfy required fields and business rules.

Specified by:

processAddProtocolAttachmentPersonnelRules in interface AddProtocolAttachmentPersonnelRule

Returns:

boolean true for valid object and false otherwise.

getProtocolAttachmentPersonnelRuleInstanceHook

public abstract ProtocolAttachmentPersonnelRuleBase getProtocolAttachmentPersonnelRuleInstanceHook()

processAddProtocolUnitBusinessRules

public boolean processAddProtocolUnitBusinessRules(AddProtocolUnitEvent addProtocolUnitEvent)

Description copied from interface: AddProtocolUnitRule

This method evaluates to true if ProtocolUnitBase objects satisfy required fields and business rules. ProtocolBase unit number is mandatory.

Specified by:

processAddProtocolUnitBusinessRules in interface AddProtocolUnitRule

Returns:

boolean true for valid object and false for invalid entry

See Also:

org.kuali.kra.iacuc.personnel.AddProtocolUnitRule#processAddProtocolUnitBusinessRules(org.kuali.kra.irb.personnel.AddProtocolUnitEvent)

getNewProtocolUnitRuleInstanceHook

protected abstract ProtocolUnitRuleBase getNewProtocolUnitRuleInstanceHook()

processRules

public boolean processRules(KraDocumentEventBaseExtension event)

Description copied from interface: BusinessRuleInterface

This method implementer must process rule for the event passed.

Specified by:

processRules in interface BusinessRuleInterface

Returns:

See Also:

BusinessRuleInterface.processRules(org.kuali.kra.rule.event.KraDocumentEventBaseExtension)

newSubmitProtocolAttachmentProtocolRuleImplInstanceHook

protected abstract SubmitProtocolAttachmentProtocolRuleImplBase newSubmitProtocolAttachmentProtocolRuleImplInstanceHook()

processSubmitAction

public boolean processSubmitAction(ProtocolDocumentBase document,
                          ProtocolSubmitAction submitAction)

Specified by:

processSubmitAction in interface ExecuteProtocolSubmitActionRule

See Also:

org.kuali.kra.irb.actions.submit.ExecuteProtocolSubmitActionRule#processSubmitAction(org.kuali.kra.irb.ProtocolDocumentBase, org.kuali.kra.irb.actions.submit.ProtocolSubmitActionBean)

newProtocolSubmitActionRuleInstanceHook

protected abstract ExecuteProtocolSubmitActionRule newProtocolSubmitActionRuleInstanceHook()

proccessCommitteeDecisionRule

public boolean proccessCommitteeDecisionRule(ProtocolDocumentBase document,
                                    CD actionBean)

Description copied from interface: ExecuteCommitteeDecisionRule

This method will check for valid user input and attach error message to fields as needed.

Specified by:

proccessCommitteeDecisionRule in interface ExecuteCommitteeDecisionRule<CD extends CommitteeDecision<? extends CommitteePersonBase>>

Parameters:

document - the ProtocolDocumentBase

actionBean - a CommitteeDecision bean

Returns:

a boolean as to whether the user input is valid

See Also:

org.kuali.kra.irb.actions.decision.ExecuteCommitteeDecisionRule#proccessCommitteeDecisionRule(org.kuali.kra.irb.ProtocolDocumentBase, org.kuali.kra.irb.actions.decision.CommitteeDecision)

newCommitteeDecisionRuleInstanceHook

protected abstract CommitteeDecisionRuleBase<CD> newCommitteeDecisionRuleInstanceHook()

proccessCommitteeDecisionAbstainerRule

public boolean proccessCommitteeDecisionAbstainerRule(ProtocolDocumentBase document,
                                             CD actionBean)

Description copied from interface: ExecuteCommitteeDecisionAbstainerRule

This method...

Specified by:

proccessCommitteeDecisionAbstainerRule in interface ExecuteCommitteeDecisionAbstainerRule<CD extends CommitteeDecision<? extends CommitteePersonBase>>

Returns:

See Also:

org.kuali.kra.irb.actions.decision.ExecuteCommitteeDecisionAbstainerRule#proccessCommitteeDecisionAbstainerRule(org.kuali.kra.irb.ProtocolDocumentBase, org.kuali.kra.irb.actions.decision.CommitteeDecision)

newCommitteeDecisionAbstainerRuleInstanceHook

protected abstract ExecuteCommitteeDecisionAbstainerRule<CD> newCommitteeDecisionAbstainerRuleInstanceHook()

proccessCommitteeDecisionRecuserRule

public boolean proccessCommitteeDecisionRecuserRule(ProtocolDocumentBase document,
                                           CD actionBean)

Description copied from interface: ExecuteCommitteeDecisionRecuserRule

This method...

Specified by:

proccessCommitteeDecisionRecuserRule in interface ExecuteCommitteeDecisionRecuserRule<CD extends CommitteeDecision<? extends CommitteePersonBase>>

Returns:

See Also:

org.kuali.kra.irb.actions.decision.ExecuteCommitteeDecisionRecuserRule#proccessCommitteeDecisionRecuserRule(org.kuali.kra.irb.ProtocolDocumentBase, org.kuali.kra.irb.actions.decision.CommitteeDecision)

newCommitteeDecisionRecuserRuleInstanceHook

protected abstract ExecuteCommitteeDecisionRecuserRule<CD> newCommitteeDecisionRecuserRuleInstanceHook()