org.kuali.kra.award.commitments

Class AwardFandaRateRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.award.commitments.AwardFandaRateRule

All Implemented Interfaces:

AddFandaRateRule, 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 AwardFandaRateRule
extends ResearchDocumentRuleBase
implements AddFandaRateRule

This class represents the AwardFandaRateRule

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkValidFandARate(AwardFandaRate awardFandaRate, String propertyPrefix) This method checks whether FandaRares are available in valid Rate table or not;
protected void	createHashMapsForRuleEvaluation(List<AwardFandaRate> awardFandaRateList, HashMap<String,String> a1, HashMap<String,String> b1) This method iterates through the awardFandaRateList and creates two hashmaps; one with on campus values and other with off campus values in it.
protected boolean	evaluateRule(List<AwardFandaRate> awardFandaRateList, HashMap<String,String> a1, HashMap<String,String> b1)
protected boolean	evaluateRuleForApplicableFandaRate(AwardFandaRate awardFandaRate, String propertyPrefix) This is a convenience method for evaluating the rule for applicableFandaRate field.
protected boolean	evaluateRuleForFandaRateTypeCode(AwardFandaRate awardFandaRate, String propertyPrefix) This is a convenience method for evaluating the rule for fandaRateTypeCode field.
protected boolean	evaluateRuleForFiscalYear(AwardFandaRate awardFandaRate, String propertyPrefix) This is a convenience method for evaluating the rule for fiscalYear field.
protected boolean	evaluateRuleForStartAndEndDates(AwardFandaRate awardFandaRate, String propertyPrefix) This is a convenience method for evaluating the rule for startDate and endDate fields.
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Looks up and returns the ParameterService.
protected boolean	isFandaRateInputInPairs(List<AwardFandaRate> awardFandaRateList) This method takes as the input a list of AwardFandaRate, iterates through it twice to find out whether both on campus and off campus entries are present for every indirectRateTypeCode.
boolean	processAddFandaRateBusinessRules(AddAwardFandaRateEvent addAwardFandaRateEvent) Rule invoked upon adding a indirect cost rate AwardDocument
boolean	processSaveFandaRateBusinessRules(AwardFandaRateSaveEvent awardFandaRateSaveEvent)

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

AwardFandaRateRule

public AwardFandaRateRule()

Method Detail

processAddFandaRateBusinessRules

public boolean processAddFandaRateBusinessRules(AddAwardFandaRateEvent addAwardFandaRateEvent)

Description copied from interface: AddFandaRateRule

Rule invoked upon adding a indirect cost rate AwardDocument

Specified by:

processAddFandaRateBusinessRules in interface AddFandaRateRule

Returns:

boolean

See Also:

#processAddFandaRateBusinessRules(org.kuali.kra.award.commitments.AddAwardFandaRateEvent)

processSaveFandaRateBusinessRules

public boolean processSaveFandaRateBusinessRules(AwardFandaRateSaveEvent awardFandaRateSaveEvent)

evaluateRuleForApplicableFandaRate

protected boolean evaluateRuleForApplicableFandaRate(AwardFandaRate awardFandaRate,
                                         String propertyPrefix)

This is a convenience method for evaluating the rule for applicableFandaRate field.

Parameters:

awardFandaRate -

propertyPrefix -

Returns:

evaluateRuleForFandaRateTypeCode

protected boolean evaluateRuleForFandaRateTypeCode(AwardFandaRate awardFandaRate,
                                       String propertyPrefix)

This is a convenience method for evaluating the rule for fandaRateTypeCode field.

Parameters:

awardFandaRate -

propertyPrefix -

Returns:

evaluateRuleForFiscalYear

protected boolean evaluateRuleForFiscalYear(AwardFandaRate awardFandaRate,
                                String propertyPrefix)

This is a convenience method for evaluating the rule for fiscalYear field.

Parameters:

awardFandaRate -

propertyPrefix -

Returns:

evaluateRuleForStartAndEndDates

protected boolean evaluateRuleForStartAndEndDates(AwardFandaRate awardFandaRate,
                                      String propertyPrefix)

This is a convenience method for evaluating the rule for startDate and endDate fields.

Parameters:

awardFandaRate -

propertyPrefix -

Returns:

checkValidFandARate

public boolean checkValidFandARate(AwardFandaRate awardFandaRate,
                          String propertyPrefix)

This method checks whether FandaRares are available in valid Rate table or not;

Parameters:

awardFandaRateList -

getParameterService

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

Description copied from class: ResearchDocumentRuleBase

Looks up and returns the ParameterService.

Overrides:

getParameterService in class ResearchDocumentRuleBase

Returns:

the parameter service.

isFandaRateInputInPairs

protected boolean isFandaRateInputInPairs(List<AwardFandaRate> awardFandaRateList)

This method takes as the input a list of AwardFandaRate, iterates through it twice to find out whether both on campus and off campus entries are present for every indirectRateTypeCode. Returns true if they both are present.

Parameters:

awardFandaRateList -

Returns:

createHashMapsForRuleEvaluation

protected void createHashMapsForRuleEvaluation(List<AwardFandaRate> awardFandaRateList,
                                   HashMap<String,String> a1,
                                   HashMap<String,String> b1)

This method iterates through the awardFandaRateList and creates two hashmaps; one with on campus values and other with off campus values in it.

Parameters:

awardFandaRateList -

a1 -

b1 -

evaluateRule

protected boolean evaluateRule(List<AwardFandaRate> awardFandaRateList,
                   HashMap<String,String> a1,
                   HashMap<String,String> b1)

Parameters:

awardFandaRateList -

a1 -

b1 -

Returns: