org.kuali.kra.irb

Class ProtocolDocumentRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

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

org.kuali.kra.irb.ProtocolDocumentRule

All Implemented Interfaces:

PermissionsRule, ExecuteProtocolAssignCmtSchedRule, ExecuteProtocolAssignReviewersRule, ExecuteProtocolAdminCorrectionRule, ExecuteProtocolModifySubmissionRule, ExecuteProtocolReviewNotRequiredRule, ExecuteCommitteeDecisionAbstainerRule<CommitteeDecision>, ExecuteCommitteeDecisionRecuserRule<CommitteeDecision>, ExecuteCommitteeDecisionRule<CommitteeDecision>, 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 ProtocolDocumentRule
extends ProtocolDocumentRuleBase<CommitteeDecision>
implements ExecuteProtocolAssignCmtSchedRule, ExecuteProtocolAssignReviewersRule, ExecuteProtocolAdminCorrectionRule, ExecuteProtocolModifySubmissionRule, ExecuteProtocolReviewNotRequiredRule, PermissionsRule

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

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getInProgressProtocolStatusCodeHook()
protected ProtocolFundingSourceAuditRuleBase	getNewProtocolFundingSourceAuditRuleInstanceHook()
protected ProtocolFundingSourceRuleBase	getNewProtocolFundingSourceRuleInstanceHook()
protected ProtocolLocationRule	getNewProtocolLocationRuleInstanceHook()
protected ProtocolPersonnelAuditRule	getNewProtocolPersonnelAuditRuleInstanceHook()
protected ProtocolReferenceRule	getNewProtocolReferenceRuleInstanceHook()
protected ProtocolResearchAreaAuditRule	getNewProtocolResearchAreaAuditRuleInstanceHook()
protected ProtocolUnitRule	getNewProtocolUnitRuleInstanceHook()
ProtocolAttachmentPersonnelRule	getProtocolAttachmentPersonnelRuleInstanceHook()
protected SaveProtocolPersonnelEventBase	getSaveProtocolPersonnelEventHook(ProtocolDocumentBase document)
protected ExecuteCommitteeDecisionAbstainerRule<CommitteeDecision>	newCommitteeDecisionAbstainerRuleInstanceHook()
protected ExecuteCommitteeDecisionRecuserRule<CommitteeDecision>	newCommitteeDecisionRecuserRuleInstanceHook()
protected CommitteeDecisionRuleBase<CommitteeDecision>	newCommitteeDecisionRuleInstanceHook()
protected ProtocolSubmitActionRule	newProtocolSubmitActionRuleInstanceHook()
protected SubmitProtocolAttachmentProtocolRuleImplBase	newSubmitProtocolAttachmentProtocolRuleImplInstanceHook()
boolean	processAddPermissionsUserBusinessRules(org.kuali.rice.krad.document.Document document, List<User> users, PermissionsUser newUser) Determines the legality of adding a user with a given role to a document.
boolean	processAdminCorrectionRule(ProtocolDocument document, AdminCorrectionBean actionBean) ProcessDefinitionDefinitionDefinition the business validation when a protocol is assigned to a committee/schedule.
boolean	processAssignReviewers(ProtocolDocument document, ProtocolAssignReviewersBean actionBean) ProcessDefinitionDefinitionDefinition the business validation when a protocol is assigned to some reviewers.
boolean	processAssignToCommitteeSchedule(ProtocolDocument document, ProtocolAssignCmtSchedBean actionBean) ProcessDefinitionDefinitionDefinition the business validation when a protocol is assigned to a committee/schedule.
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processDeletePermissionsUserBusinessRules(org.kuali.rice.krad.document.Document document, List<User> users, int index) Determines the legality of deleting a user from the given document.
boolean	processEditPermissionsUserRolesBusinessRules(org.kuali.rice.krad.document.Document document, List<User> users, PermissionsUserEditRoles editRoles) Determines if it is legal to edit the roles for a user.
boolean	processModifySubmissionRule(ProtocolDocument document, ProtocolModifySubmissionBean actionBean) This method is the rule for modifying a protocol submission.
boolean	processReviewNotRequiredRule(ProtocolDocument document, ProtocolReviewNotRequiredBean actionBean) This method validates the business rules for setting a protocol to review not required.
boolean	processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)

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

proccessCommitteeDecisionAbstainerRule, proccessCommitteeDecisionRecuserRule, proccessCommitteeDecisionRule, processAddProtocolAttachmentPersonnelRules, processAddProtocolFundingSourceBusinessRules, processAddProtocolLocationBusinessRules, processAddProtocolReferenceBusinessRules, processAddProtocolUnitBusinessRules, processCustomRouteDocumentBusinessRules, processLeadUnitBusinessRules, processProtocolLocationBusinessRules, processProtocolResearchAreaBusinessRules, processRules, 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

ProtocolDocumentRule

public ProtocolDocumentRule()

Method Detail

processCustomSaveDocumentBusinessRules

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

Overrides:

processCustomSaveDocumentBusinessRules in class ProtocolDocumentRuleBase<CommitteeDecision>

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 ProtocolDocumentRuleBase<CommitteeDecision>

See Also:

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

processAddPermissionsUserBusinessRules

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

Description copied from interface: PermissionsRule

Determines the legality of adding a user with a given role to a document.

Specified by:

processAddPermissionsUserBusinessRules in interface PermissionsRule

Overrides:

processAddPermissionsUserBusinessRules in class ProtocolDocumentRuleBase<CommitteeDecision>

Parameters:

document - the document.

users - the current list of users who have a role in the document

newUser - the new user to add to the document

Returns:

true if the addition is valid; otherwise false.

See Also:

org.kuali.kra.common.permissions.rule.PermissionsRule#processAddPermissionsUserBusinessRules(org.kuali.core.document.Document, java.util.List, org.kuali.kra.common.permissions.bo.PermissionsUser)

processDeletePermissionsUserBusinessRules

public boolean processDeletePermissionsUserBusinessRules(org.kuali.rice.krad.document.Document document,
                                                List<User> users,
                                                int index)

Description copied from interface: PermissionsRule

Determines the legality of deleting a user from the given document.

Specified by:

processDeletePermissionsUserBusinessRules in interface PermissionsRule

Parameters:

document - the document.

users - list of current users who have a role in the document

index - the index into "users" of the user to delete

Returns:

true if the deletion is valid; otherwise false.

See Also:

org.kuali.kra.common.permissions.rule.PermissionsRule#processDeletePermissionsUserBusinessRules(org.kuali.core.document.Document, java.util.List, int)

processEditPermissionsUserRolesBusinessRules

public boolean processEditPermissionsUserRolesBusinessRules(org.kuali.rice.krad.document.Document document,
                                                   List<User> users,
                                                   PermissionsUserEditRoles editRoles)

Description copied from interface: PermissionsRule

Determines if it is legal to edit the roles for a user.

Specified by:

processEditPermissionsUserRolesBusinessRules in interface PermissionsRule

Parameters:

document - the document.

users - list of current users who have a role in the document

editRoles - the new set of roles for the user

Returns:

true if the role change is valid; otherwise false.

See Also:

org.kuali.kra.common.permissions.rule.PermissionsRule#processEditPermissionsUserRolesBusinessRules(org.kuali.core.document.Document, java.util.List, org.kuali.kra.common.permissions.bo.PermissionsUserEditRoles)

processAssignToCommitteeSchedule

public boolean processAssignToCommitteeSchedule(ProtocolDocument document,
                                       ProtocolAssignCmtSchedBean actionBean)

Description copied from interface: ExecuteProtocolAssignCmtSchedRule

ProcessDefinitionDefinitionDefinition the business validation when a protocol is assigned to a committee/schedule.

Specified by:

processAssignToCommitteeSchedule in interface ExecuteProtocolAssignCmtSchedRule

Parameters:

document - the protocol document

actionBean - contains the committee/schedule to assign to

Returns:

true if valid; otherwise false

See Also:

ExecuteProtocolAssignCmtSchedRule.processAssignToCommitteeSchedule(org.kuali.kra.irb.ProtocolDocument, org.kuali.kra.irb.actions.assigncmtsched.ProtocolAssignCmtSchedBean)

processAssignReviewers

public boolean processAssignReviewers(ProtocolDocument document,
                             ProtocolAssignReviewersBean actionBean)

Description copied from interface: ExecuteProtocolAssignReviewersRule

ProcessDefinitionDefinitionDefinition the business validation when a protocol is assigned to some reviewers.

Specified by:

processAssignReviewers in interface ExecuteProtocolAssignReviewersRule

Parameters:

document - the protocol document

actionBean - contains the reviewers to assign to

Returns:

true if valid; otherwise false

See Also:

ExecuteProtocolAssignReviewersRule.processAssignReviewers(org.kuali.kra.irb.ProtocolDocument, org.kuali.kra.irb.actions.assignreviewers.ProtocolAssignReviewersBean)

processAdminCorrectionRule

public boolean processAdminCorrectionRule(ProtocolDocument document,
                                 AdminCorrectionBean actionBean)

Description copied from interface: ExecuteProtocolAdminCorrectionRule

ProcessDefinitionDefinitionDefinition the business validation when a protocol is assigned to a committee/schedule.

Specified by:

processAdminCorrectionRule in interface ExecuteProtocolAdminCorrectionRule

Parameters:

document - the protocol document

actionBean - contains the committee/schedule to assign to

Returns:

true if valid; otherwise false

processModifySubmissionRule

public boolean processModifySubmissionRule(ProtocolDocument document,
                                  ProtocolModifySubmissionBean actionBean)

Description copied from interface: ExecuteProtocolModifySubmissionRule

This method is the rule for modifying a protocol submission.

Specified by:

processModifySubmissionRule in interface ExecuteProtocolModifySubmissionRule

Returns:

processReviewNotRequiredRule

public boolean processReviewNotRequiredRule(ProtocolDocument document,
                                   ProtocolReviewNotRequiredBean actionBean)

Description copied from interface: ExecuteProtocolReviewNotRequiredRule

This method validates the business rules for setting a protocol to review not required.

Specified by:

processReviewNotRequiredRule in interface ExecuteProtocolReviewNotRequiredRule

Returns:

getInProgressProtocolStatusCodeHook

protected String getInProgressProtocolStatusCodeHook()

Specified by:

getInProgressProtocolStatusCodeHook in class ProtocolDocumentRuleBase<CommitteeDecision>

getNewProtocolFundingSourceAuditRuleInstanceHook

protected ProtocolFundingSourceAuditRuleBase getNewProtocolFundingSourceAuditRuleInstanceHook()

Specified by:

getNewProtocolFundingSourceAuditRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

getNewProtocolPersonnelAuditRuleInstanceHook

protected ProtocolPersonnelAuditRule getNewProtocolPersonnelAuditRuleInstanceHook()

Specified by:

getNewProtocolPersonnelAuditRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

getNewProtocolResearchAreaAuditRuleInstanceHook

protected ProtocolResearchAreaAuditRule getNewProtocolResearchAreaAuditRuleInstanceHook()

Specified by:

getNewProtocolResearchAreaAuditRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

getSaveProtocolPersonnelEventHook

protected SaveProtocolPersonnelEventBase getSaveProtocolPersonnelEventHook(ProtocolDocumentBase document)

Specified by:

getSaveProtocolPersonnelEventHook in class ProtocolDocumentRuleBase<CommitteeDecision>

getNewProtocolReferenceRuleInstanceHook

protected ProtocolReferenceRule getNewProtocolReferenceRuleInstanceHook()

Specified by:

getNewProtocolReferenceRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

getNewProtocolLocationRuleInstanceHook

protected ProtocolLocationRule getNewProtocolLocationRuleInstanceHook()

Specified by:

getNewProtocolLocationRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

getNewProtocolFundingSourceRuleInstanceHook

protected ProtocolFundingSourceRuleBase getNewProtocolFundingSourceRuleInstanceHook()

Specified by:

getNewProtocolFundingSourceRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

getProtocolAttachmentPersonnelRuleInstanceHook

public ProtocolAttachmentPersonnelRule getProtocolAttachmentPersonnelRuleInstanceHook()

Specified by:

getProtocolAttachmentPersonnelRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

getNewProtocolUnitRuleInstanceHook

protected ProtocolUnitRule getNewProtocolUnitRuleInstanceHook()

Specified by:

getNewProtocolUnitRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

newSubmitProtocolAttachmentProtocolRuleImplInstanceHook

protected SubmitProtocolAttachmentProtocolRuleImplBase newSubmitProtocolAttachmentProtocolRuleImplInstanceHook()

Specified by:

newSubmitProtocolAttachmentProtocolRuleImplInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

newProtocolSubmitActionRuleInstanceHook

protected ProtocolSubmitActionRule newProtocolSubmitActionRuleInstanceHook()

Specified by:

newProtocolSubmitActionRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

newCommitteeDecisionRuleInstanceHook

protected CommitteeDecisionRuleBase<CommitteeDecision> newCommitteeDecisionRuleInstanceHook()

Specified by:

newCommitteeDecisionRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

newCommitteeDecisionAbstainerRuleInstanceHook

protected ExecuteCommitteeDecisionAbstainerRule<CommitteeDecision> newCommitteeDecisionAbstainerRuleInstanceHook()

Specified by:

newCommitteeDecisionAbstainerRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>

newCommitteeDecisionRecuserRuleInstanceHook

protected ExecuteCommitteeDecisionRecuserRule<CommitteeDecision> newCommitteeDecisionRecuserRuleInstanceHook()

Specified by:

newCommitteeDecisionRecuserRuleInstanceHook in class ProtocolDocumentRuleBase<CommitteeDecision>