org.kuali.kra.proposaldevelopment.rules

Class ProposalDevelopmentKeyPersonsRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.proposaldevelopment.rules.ProposalDevelopmentKeyPersonsRule

All Implemented Interfaces:

AddKeyPersonRule, CalculateCreditSplitRule, ChangeKeyPersonRule, 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 ProposalDevelopmentKeyPersonsRule
extends ResearchDocumentRuleBase
implements AddKeyPersonRule, ChangeKeyPersonRule, CalculateCreditSplitRule

Implementation of business rules required for the Key Persons Page of the ProposalDevelopmentDocument.

Version:

$Revision: 1.46 $

Author:

$Author: cdenne $

See Also:

org.kuali.rice.kns.rules.BusinessRule

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

Method Summary

Methods

Modifier and Type	Method and Description
protected KcPersonService	getKcPersonService() Gets the KcPersonSevice.
boolean	processAddKeyPersonBusinessRules(ProposalDevelopmentDocument document, ProposalPerson person) Validate the following One principal investigator at a time 0 or more Key Persons or Co-Investigators are allowed A person cannot have multiple roles, ie.
boolean	processCalculateCreditSplitBusinessRules(ProposalDevelopmentDocument document) Rule invoked upon calculating a credit split for investigators ProposalDevelopmentDocument
boolean	processChangeKeyPersonBusinessRules(ProposalPerson proposalPerson, org.kuali.rice.krad.bo.BusinessObject source, int index) Either adding a degree or unit can trigger this rule to be validated
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processSaveKeyPersonBusinessRules(ProposalDevelopmentDocument document) Rule invoked upon saving persons to a ProposalDevelopmentDocument
protected void	reportErrorWithPrefix(String errorPathPrefix, String propertyName, String errorKey, String... errorParams)

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

addAuditError, getBusinessObjectService, getErrorReporter, getKnsDictionaryValidationService, getParameterService, getSoftErrors, hasPermission, hasPermission, hasRole, hasRole, isInvalid, isValid, keyValue, processBudgetVersionsBusinessRule, processRunAuditBusinessRules, 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, 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

ProposalDevelopmentKeyPersonsRule

public ProposalDevelopmentKeyPersonsRule()

Method Detail

processCustomSaveDocumentBusinessRules

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

Overrides:

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

See Also:

DocumentRuleBase.processCustomSaveDocumentBusinessRules(Document)

processSaveKeyPersonBusinessRules

public boolean processSaveKeyPersonBusinessRules(ProposalDevelopmentDocument document)

Rule invoked upon saving persons to a ProposalDevelopmentDocument

Parameters:

document - ProposalDevelopmentDocument being saved

Returns:

boolean

processAddKeyPersonBusinessRules

public boolean processAddKeyPersonBusinessRules(ProposalDevelopmentDocument document,
                                       ProposalPerson person)

Validate the following

• One principal investigator at a time
• 0 or more Key Persons or Co-Investigators are allowed
• A person cannot have multiple roles, ie. a person can only be added as a key person once.

Specified by:

processAddKeyPersonBusinessRules in interface AddKeyPersonRule

Returns:

boolean

See Also:

AddKeyPersonRule.processAddKeyPersonBusinessRules(ProposalDevelopmentDocument,ProposalPerson)

reportErrorWithPrefix

protected void reportErrorWithPrefix(String errorPathPrefix,
                         String propertyName,
                         String errorKey,
                         String... errorParams)

See Also:

ResearchDocumentRuleBase.reportError(String, String, String...)

getKcPersonService

protected KcPersonService getKcPersonService()

Gets the KcPersonSevice.

Returns:

the service.

processChangeKeyPersonBusinessRules

public boolean processChangeKeyPersonBusinessRules(ProposalPerson proposalPerson,
                                          org.kuali.rice.krad.bo.BusinessObject source,
                                          int index)

Either adding a degree or unit can trigger this rule to be validated

Specified by:

processChangeKeyPersonBusinessRules in interface ChangeKeyPersonRule

source - the event source acting on the rule

Returns:

boolean pass or fail

See Also:

org.kuali.kra.proposaldevelopment.rule.ChangeKeyPersonRule#processChangeKeyPersonBusinessRules(org.kuali.kra.proposaldevelopment.bo.ProposalPerson, org.kuali.rice.krad.bo.BusinessObject), ProposalDevelopmentKeyPersonnelAction.insertDegree(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse), ProposalDevelopmentKeyPersonnelAction.insertUnit(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

processCalculateCreditSplitBusinessRules

public boolean processCalculateCreditSplitBusinessRules(ProposalDevelopmentDocument document)

Description copied from interface: CalculateCreditSplitRule

Rule invoked upon calculating a credit split for investigators ProposalDevelopmentDocument

Specified by:

processCalculateCreditSplitBusinessRules in interface CalculateCreditSplitRule

Returns:

boolean