org.kuali.kra.proposaldevelopment.rules

Class ProposalDevelopmentNarrativeRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.proposaldevelopment.rules.ProposalDevelopmentNarrativeRule

All Implemented Interfaces:

AddNarrativeRule, NewNarrativeUserRightsRule, SaveNarrativesRule, 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 ProposalDevelopmentNarrativeRule
extends ResearchDocumentRuleBase
implements AddNarrativeRule, SaveNarrativesRule, NewNarrativeUserRightsRule

Implementation of business rules required for the Proposal attachment page of the ProposalDevelopmentDocument.

Version:

1.0

Author:

kualidev@oncourse.iu.edu

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

Method Summary

Methods

Modifier and Type	Method and Description
protected KcAttachmentService	getKcAttachmentService() This method gets the attachment service
protected KcPersonService	getKcPersonService() Gets the KC Person Service.
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Gets the parameter service.
protected org.kuali.rice.kim.api.identity.PersonService	getPersonService()
boolean	processAddNarrativeBusinessRules(AddNarrativeEvent narrativeEvent) This method is used to validate narratives and institute proposal attachments before adding.
boolean	processNewNarrativeUserRightsBusinessRules(ProposalDevelopmentDocument document, List<NarrativeUserRights> newNarrativeUserRights, int narrativeIndex) Determines the legality of editing a Narrative's user rights.
boolean	processSaveNarrativesBusinessRules(SaveNarrativesEvent saveNarrativesEvent) This method is used to validate narratives and institute proposal attachments before saving.

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

addAuditError, getBusinessObjectService, getErrorReporter, getKnsDictionaryValidationService, 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, 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

ProposalDevelopmentNarrativeRule

public ProposalDevelopmentNarrativeRule()

Method Detail

processAddNarrativeBusinessRules

public boolean processAddNarrativeBusinessRules(AddNarrativeEvent narrativeEvent)

This method is used to validate narratives and institute proposal attachments before adding. It checks whether the narratives are duplicated for those of which have allowMultiple flag set as false.

Specified by:

processAddNarrativeBusinessRules in interface AddNarrativeRule

Returns:

boolean

See Also:

AddNarrativeRule.processAddNarrativeBusinessRules(org.kuali.kra.proposaldevelopment.rule.event.AddNarrativeEvent)

processSaveNarrativesBusinessRules

public boolean processSaveNarrativesBusinessRules(SaveNarrativesEvent saveNarrativesEvent)

This method is used to validate narratives and institute proposal attachments before saving. It checks whether the narratives are duplicated for those of which have allowMultiple flag set as false.

Specified by:

processSaveNarrativesBusinessRules in interface SaveNarrativesRule

Returns:

boolean

See Also:

SaveNarrativesRule.processSaveNarrativesBusinessRules(org.kuali.kra.proposaldevelopment.rule.event.SaveNarrativesEvent)

processNewNarrativeUserRightsBusinessRules

public boolean processNewNarrativeUserRightsBusinessRules(ProposalDevelopmentDocument document,
                                                 List<NarrativeUserRights> newNarrativeUserRights,
                                                 int narrativeIndex)

Description copied from interface: NewNarrativeUserRightsRule

Determines the legality of editing a Narrative's user rights.

Specified by:

processNewNarrativeUserRightsBusinessRules in interface NewNarrativeUserRightsRule

Parameters:

document - the proposal development document.

newNarrativeUserRights - the new narrative user rights

narrativeIndex - the index of the narrative in the document

Returns:

true if the modification is valid; otherwise false.

See Also:

NewNarrativeUserRightsRule.processNewNarrativeUserRightsBusinessRules(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument, java.util.List, int)

getKcAttachmentService

protected KcAttachmentService getKcAttachmentService()

This method gets the attachment service

Returns:

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Gets the parameter service.

Overrides:

getParameterService in class ResearchDocumentRuleBase

Returns:

the parameter service.

See Also:

ResearchDocumentRuleBase.getParameterService()

getKcPersonService

protected KcPersonService getKcPersonService()

Gets the KC Person Service.

Returns:

KC Person Service.

getPersonService

protected org.kuali.rice.kim.api.identity.PersonService getPersonService()

Overrides:

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