org.kuali.kra.award

Class AwardDocumentRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.award.AwardDocumentRule

All Implemented Interfaces:

AwardTemplateSyncRule, AddFandaRateRule, AwardFandaRateSaveRule, AwardProjectPersonsSaveRule, AwardDetailsAndDatesRule, AwardReportTermRecipientRule, AwardReportTermRule, AwardCloseoutRule, AwardPaymentScheduleRule, AwardApprovedEquipmentRule, AwardApprovedForeignTravelRule, AddAwardAttachmentRule, AwardCommentsRule, PermissionsRule, 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 AwardDocumentRule
extends ResearchDocumentRuleBase
implements AwardPaymentScheduleRule, AwardApprovedEquipmentRule, AwardApprovedForeignTravelRule, AddFandaRateRule, AwardFandaRateSaveRule, AwardDetailsAndDatesRule, AwardProjectPersonsSaveRule, PermissionsRule, AwardReportTermRule, AwardReportTermRecipientRule, AwardCloseoutRule, AwardTemplateSyncRule, AwardCommentsRule, BusinessRuleInterface, AddAwardAttachmentRule, org.kuali.rice.krad.rules.rule.DocumentAuditRule

Main Business Rule class for AwardDocument. Responsible for delegating rules to independent rule classes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AWARD_ERROR_PATH
static boolean	CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME
static String	DOCUMENT_ERROR_PATH
static boolean	VALIDATION_REQUIRED

Fields inherited from interface org.kuali.kra.award.paymentreports.paymentschedule.AwardPaymentScheduleRule

PAYMENT_SCHEDULE_ITEMS_LIST_ERROR_KEY

Fields inherited from interface org.kuali.kra.award.paymentreports.specialapproval.approvedequipment.AwardApprovedEquipmentRule

APPROVED_EQUIPMENT_ITEMS_LIST_ERROR_KEY

Fields inherited from interface org.kuali.kra.award.paymentreports.specialapproval.foreigntravel.AwardApprovedForeignTravelRule

APPROVED_FOREIGN_TRAVEL_LIST_ERROR_KEY, ERROR_AWARD_APPROVED_FOREIGN_INVALID_FIELD, ERROR_AWARD_APPROVED_FOREIGN_TRAVEL_END_DATE_BEFORE_START_DATE, ERROR_AWARD_APPROVED_FOREIGN_TRAVEL_NOT_UNIQUE

Fields inherited from interface org.kuali.kra.award.contacts.AwardProjectPersonsSaveRule

AWARD_PROJECT_PERSON_LIST_ERROR_KEY, ERROR_AWARD_PROJECT_KEY_PERSON_ROLE_REQUIRED, ERROR_AWARD_PROJECT_PERSON_DUPLICATE_UNITS, ERROR_AWARD_PROJECT_PERSON_LEAD_UNIT_REQUIRED, ERROR_AWARD_PROJECT_PERSON_MULTIPLE_PI_EXISTS, ERROR_AWARD_PROJECT_PERSON_NO_PI, ERROR_AWARD_PROJECT_PERSON_UNIT_DETAILS_REQUIRED

Fields inherited from interface org.kuali.kra.award.paymentreports.awardreports.AwardReportTermRule

PAYMENT_SCHEDULE_ITEMS_LIST_ERROR_KEY

Fields inherited from interface org.kuali.kra.award.paymentreports.awardreports.AwardReportTermRecipientRule

PAYMENT_SCHEDULE_ITEMS_LIST_ERROR_KEY

Fields inherited from interface org.kuali.kra.award.paymentreports.closeout.AwardCloseoutRule

CLOSEOUT_ITEMS_LIST_ERROR_KEY

Constructor Summary

Constructors

Constructor and Description
AwardDocumentRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	evaluateBusinessRuleForFrequencyBaseCodeField(AwardReportTerm awardReportTerm, int index)
protected boolean	evaluateBusinessRuleForFrequencyCodeField(AwardReportTerm awardReportTerm, int index)
protected boolean	evaluateBusinessRuleForRecipients(AwardReportTerm awardReportTerm, int index) This method checks that each of the report term's recipients has a name/organization
protected boolean	evaluateBusinessRuleForReportCodeField(AwardReportTerm awardReportTerm, int index)
protected List<org.kuali.rice.core.api.util.KeyValue>	getFrequencyBaseCodes(String frequencyCode)
protected List<org.kuali.rice.core.api.util.KeyValue>	getFrequencyCodes(String reportClassCode, String reportCode)
protected List<org.kuali.rice.core.api.util.KeyValue>	getReportCodes(String reportClassCode)
protected boolean	isValidFrequency(AwardReportTerm awardReportTerm, List<org.kuali.rice.core.api.util.KeyValue> frequencyCodes)
protected boolean	isValidFrequencyBase(AwardReportTerm awardReportTerm, List<org.kuali.rice.core.api.util.KeyValue> frequencyBaseCodes)
protected boolean	isValidReportCode(AwardReportTerm awardReportTerm, List<org.kuali.rice.core.api.util.KeyValue> reportCodes)
boolean	processAddAwardCloseoutBusinessRules(AddAwardCloseoutRuleEvent addAwardCloseoutRuleEvent) This method is used to validate a new AwardCloseout to be added to an Award
boolean	processAddAwardPaymentScheduleBusinessRules(AddAwardPaymentScheduleRuleEvent event) This method is used to validate a new AwardPaymentSchedule to be added to an Award
boolean	processAddAwardReportTermBusinessRules(AddAwardReportTermRuleEvent event) This method is used to validate a new AwardPaymentSchedule to be added to an Award
boolean	processAddAwardReportTermRecipientBusinessRules(AddAwardReportTermRecipientRuleEvent event) This method is used to validate a new AwardPaymentSchedule to be added to an Award
boolean	processAddAwardReportTermRecipientEvent(AddAwardReportTermRecipientRuleEvent addAwardReportTermRecipientRuleEvent) This method...
boolean	processAddAwardTransferringSponsorEvent(AddAwardTransferringSponsorEvent addAwardTransferringSponsorEvent) Check rules associated with adding a new Award Transferring Sponsor AwardDocument
boolean	processAddFandaRateBusinessRules(AddAwardFandaRateEvent addAwardFandaRateEvent) Rule invoked upon adding a indirect cost rate AwardDocument
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	processApprovedSubawardBusinessRules(org.kuali.rice.krad.document.Document document) process ApprovedSubaward business rules.
boolean	processAwardApprovedEquipmentBusinessRules(AwardApprovedEquipmentRuleEvent event) This method is used to validate AwardApprovedEquipment items in an Award
boolean	processAwardApprovedForeignTravelBusinessRules(AwardApprovedForeignTravelRuleEvent event) This method is used to validate AwardApprovedForeignTravel in an Award
boolean	processAwardCloseoutBusinessRules(AwardCloseoutRuleEvent awardCloseoutRuleEvent) This method is used to validate AwardCloseout items in an Award
boolean	processAwardCommentsBusinessRules(AwardCommentsRuleEvent ruleEvent)
boolean	processAwardPaymentScheduleBusinessRules(AwardPaymentScheduleRuleEvent event) This method is used to validate AwardPaymentSchedule items in an Award
boolean	processAwardReportTermBusinessRules(AwardReportTermRuleEvent event) This method is used to validate AwardPaymentSchedule items in an Award
boolean	processAwardReportTermBusinessRules(org.kuali.rice.krad.document.Document document) This method...
boolean	processAwardReportTermRecipientBusinessRules(AwardReportTermRecipientRuleEvent event) This method is used to validate AwardPaymentSchedule items in an Award
boolean	processAwardReportTermRecipientEvent(AwardReportTermRecipientRuleEvent event) This method...
boolean	processAwardTemplateSyncRules(AwardTemplateSyncEvent awardTemplateSyncEvent) Rule invoked upon syncing an Award Template AwardTemplateSyncEvent
protected boolean	processCustomRouteDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
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	processRules(KraDocumentEventBaseExtension event) This method implementer must process rule for the event passed.
boolean	processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processsAddAttachmentRule(AddAwardAttachmentEvent event)
boolean	processSaveAwardDetailsAndDates(AwardDetailsAndDatesSaveEvent awardDetailsAndDatesSaveEvent) Check rules associated with Saving Award Details and Dates panel AwardDocument
boolean	processSaveAwardProjectPersonsBusinessRules(SaveAwardProjectPersonsRuleEvent event) This method should be called before adding a new Project Person
boolean	processSaveFandaRateBusinessRules(AwardFandaRateSaveEvent awardFandaRateSaveEvent) Rule invoked when doing a save action on the commitments tab.
protected void	reportAndCreateAuditCluster()

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

Field Detail

DOCUMENT_ERROR_PATH

public static final String DOCUMENT_ERROR_PATH

See Also:

Constant Field Values

AWARD_ERROR_PATH

public static final String AWARD_ERROR_PATH

See Also:

Constant Field Values

VALIDATION_REQUIRED

public static final boolean VALIDATION_REQUIRED

See Also:

Constant Field Values

CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME

public static final boolean CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME

See Also:

Constant Field Values

Constructor Detail

AwardDocumentRule

public AwardDocumentRule()

Method Detail

processAwardApprovedEquipmentBusinessRules

public boolean processAwardApprovedEquipmentBusinessRules(AwardApprovedEquipmentRuleEvent event)

Description copied from interface: AwardApprovedEquipmentRule

This method is used to validate AwardApprovedEquipment items in an Award

Specified by:

processAwardApprovedEquipmentBusinessRules in interface AwardApprovedEquipmentRule

Returns:

See Also:

#processAwardApprovedEquipmentBusinessRules(org.kuali.kra.award.paymentreports.specialapproval.approvedequipment.AwardApprovedEquipmentRuleEvent)

processAwardApprovedForeignTravelBusinessRules

public boolean processAwardApprovedForeignTravelBusinessRules(AwardApprovedForeignTravelRuleEvent event)

Description copied from interface: AwardApprovedForeignTravelRule

This method is used to validate AwardApprovedForeignTravel in an Award

Specified by:

processAwardApprovedForeignTravelBusinessRules in interface AwardApprovedForeignTravelRule

Returns:

See Also:

(org.kuali.kra.award.paymentreports.specialapproval.foreigntravel.AwardApprovedForeignTravelRuleEvent), #processAwardApprovedForeignTravelBusinessRules(org.kuali.kra.award.paymentreports.specialapproval.foreigntravel.AwardApprovedForeignTravelRuleEvent)

processAwardPaymentScheduleBusinessRules

public boolean processAwardPaymentScheduleBusinessRules(AwardPaymentScheduleRuleEvent event)

Description copied from interface: AwardPaymentScheduleRule

This method is used to validate AwardPaymentSchedule items in an Award

Specified by:

processAwardPaymentScheduleBusinessRules in interface AwardPaymentScheduleRule

Returns:

See Also:

AwardPaymentScheduleRule.processAwardPaymentScheduleBusinessRules( org.kuali.kra.award.paymentreports.paymentschedule.AwardPaymentScheduleRuleEvent)

processAddAwardPaymentScheduleBusinessRules

public boolean processAddAwardPaymentScheduleBusinessRules(AddAwardPaymentScheduleRuleEvent event)

Description copied from interface: AwardPaymentScheduleRule

This method is used to validate a new AwardPaymentSchedule to be added to an Award

Specified by:

processAddAwardPaymentScheduleBusinessRules in interface AwardPaymentScheduleRule

Returns:

See Also:

AwardPaymentScheduleRule.processAddAwardPaymentScheduleBusinessRules( org.kuali.kra.award.paymentreports.paymentschedule.AddAwardPaymentScheduleRuleEvent)

processAddAwardTransferringSponsorEvent

public boolean processAddAwardTransferringSponsorEvent(AddAwardTransferringSponsorEvent addAwardTransferringSponsorEvent)

Description copied from interface: AwardDetailsAndDatesRule

Check rules associated with adding a new Award Transferring Sponsor AwardDocument

Specified by:

processAddAwardTransferringSponsorEvent in interface AwardDetailsAndDatesRule

Returns:

boolean

See Also:

(org.kuali.kra.award.rule.event.AddAwardTransferringSponsorEvent)

processAddAwardCloseoutBusinessRules

public boolean processAddAwardCloseoutBusinessRules(AddAwardCloseoutRuleEvent addAwardCloseoutRuleEvent)

Description copied from interface: AwardCloseoutRule

This method is used to validate a new AwardCloseout to be added to an Award

Specified by:

processAddAwardCloseoutBusinessRules in interface AwardCloseoutRule

Returns:

See Also:

AwardCloseoutRule.processAddAwardCloseoutBusinessRules( org.kuali.kra.award.paymentreports.closeout.AddAwardCloseoutRuleEvent)

processAwardCloseoutBusinessRules

public boolean processAwardCloseoutBusinessRules(AwardCloseoutRuleEvent awardCloseoutRuleEvent)

Description copied from interface: AwardCloseoutRule

This method is used to validate AwardCloseout items in an Award

Specified by:

processAwardCloseoutBusinessRules in interface AwardCloseoutRule

Returns:

See Also:

AwardCloseoutRule.processAwardCloseoutBusinessRules( org.kuali.kra.award.paymentreports.closeout.AwardCloseoutRuleEvent)

processSaveAwardProjectPersonsBusinessRules

public boolean processSaveAwardProjectPersonsBusinessRules(SaveAwardProjectPersonsRuleEvent event)

Description copied from interface: AwardProjectPersonsSaveRule

This method should be called before adding a new Project Person

Specified by:

processSaveAwardProjectPersonsBusinessRules in interface AwardProjectPersonsSaveRule

Returns:

See Also:

#processSaveAwardProjectPersonsBusinessRules(org.kuali.kra.award.contacts.SaveAwardProjectPersonsRuleEvent)

processCustomRouteDocumentBusinessRules

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

Overrides:

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

See Also:

org.kuali.core.rules.DocumentRuleBase#processCustomRouteDocumentBusinessRules( 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

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)

processSaveAwardDetailsAndDates

public boolean processSaveAwardDetailsAndDates(AwardDetailsAndDatesSaveEvent awardDetailsAndDatesSaveEvent)

Description copied from interface: AwardDetailsAndDatesRule

Check rules associated with Saving Award Details and Dates panel AwardDocument

Specified by:

processSaveAwardDetailsAndDates in interface AwardDetailsAndDatesRule

Returns:

boolean

See Also:

AwardDetailsAndDatesRule.processSaveAwardDetailsAndDates(org.kuali.kra.award.detailsdates.AwardDetailsAndDatesSaveEvent)

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( org.kuali.rice.krad.document.Document)

processAwardCommentsBusinessRules

public boolean processAwardCommentsBusinessRules(AwardCommentsRuleEvent ruleEvent)

Specified by:

processAwardCommentsBusinessRules in interface AwardCommentsRule

processApprovedSubawardBusinessRules

public boolean processApprovedSubawardBusinessRules(org.kuali.rice.krad.document.Document document)

process ApprovedSubaward business rules.

Parameters:

awardDocument -

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)

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)

Description copied from interface: AwardFandaRateSaveRule

Rule invoked when doing a save action on the commitments tab.

Specified by:

processSaveFandaRateBusinessRules in interface AwardFandaRateSaveRule

Returns:

boolean

processAwardReportTermBusinessRules

public boolean processAwardReportTermBusinessRules(org.kuali.rice.krad.document.Document document)

This method...

Parameters:

document -

Returns:

processAwardReportTermBusinessRules

public boolean processAwardReportTermBusinessRules(AwardReportTermRuleEvent event)

Description copied from interface: AwardReportTermRule

This method is used to validate AwardPaymentSchedule items in an Award

Specified by:

processAwardReportTermBusinessRules in interface AwardReportTermRule

Returns:

See Also:

AwardReportTermRule.processAwardReportTermBusinessRules( org.kuali.kra.award.paymentreports.awardreports.AwardReportTermRuleEvent)

evaluateBusinessRuleForReportCodeField

protected boolean evaluateBusinessRuleForReportCodeField(AwardReportTerm awardReportTerm,
                                             int index)

isValidReportCode

protected boolean isValidReportCode(AwardReportTerm awardReportTerm,
                        List<org.kuali.rice.core.api.util.KeyValue> reportCodes)

evaluateBusinessRuleForFrequencyCodeField

protected boolean evaluateBusinessRuleForFrequencyCodeField(AwardReportTerm awardReportTerm,
                                                int index)

isValidFrequency

protected boolean isValidFrequency(AwardReportTerm awardReportTerm,
                       List<org.kuali.rice.core.api.util.KeyValue> frequencyCodes)

evaluateBusinessRuleForFrequencyBaseCodeField

protected boolean evaluateBusinessRuleForFrequencyBaseCodeField(AwardReportTerm awardReportTerm,
                                                    int index)

isValidFrequencyBase

protected boolean isValidFrequencyBase(AwardReportTerm awardReportTerm,
                           List<org.kuali.rice.core.api.util.KeyValue> frequencyBaseCodes)

evaluateBusinessRuleForRecipients

protected boolean evaluateBusinessRuleForRecipients(AwardReportTerm awardReportTerm,
                                        int index)

This method checks that each of the report term's recipients has a name/organization

Parameters:

awardReportTerm -

index -

Returns:

getReportCodes

protected List<org.kuali.rice.core.api.util.KeyValue> getReportCodes(String reportClassCode)

getFrequencyCodes

protected List<org.kuali.rice.core.api.util.KeyValue> getFrequencyCodes(String reportClassCode,
                                                            String reportCode)

getFrequencyBaseCodes

protected List<org.kuali.rice.core.api.util.KeyValue> getFrequencyBaseCodes(String frequencyCode)

processAddAwardReportTermBusinessRules

public boolean processAddAwardReportTermBusinessRules(AddAwardReportTermRuleEvent event)

Description copied from interface: AwardReportTermRule

This method is used to validate a new AwardPaymentSchedule to be added to an Award

Specified by:

processAddAwardReportTermBusinessRules in interface AwardReportTermRule

Returns:

See Also:

AwardReportTermRule.processAddAwardReportTermBusinessRules( org.kuali.kra.award.paymentreports.awardreports.AddAwardReportTermRuleEvent)

processAwardReportTermRecipientBusinessRules

public boolean processAwardReportTermRecipientBusinessRules(AwardReportTermRecipientRuleEvent event)

Description copied from interface: AwardReportTermRecipientRule

This method is used to validate AwardPaymentSchedule items in an Award

Specified by:

processAwardReportTermRecipientBusinessRules in interface AwardReportTermRecipientRule

Returns:

See Also:

AwardReportTermRecipientRule.processAwardReportTermRecipientBusinessRules( org.kuali.kra.award.paymentreports.awardreports.AwardReportTermRecipientRuleEvent)

processAddAwardReportTermRecipientBusinessRules

public boolean processAddAwardReportTermRecipientBusinessRules(AddAwardReportTermRecipientRuleEvent event)

Description copied from interface: AwardReportTermRecipientRule

This method is used to validate a new AwardPaymentSchedule to be added to an Award

Specified by:

processAddAwardReportTermRecipientBusinessRules in interface AwardReportTermRecipientRule

Returns:

See Also:

AwardReportTermRecipientRule.processAddAwardReportTermRecipientBusinessRules( org.kuali.kra.award.paymentreports.awardreports.AddAwardReportTermRecipientRuleEvent)

processAddAwardReportTermRecipientEvent

public boolean processAddAwardReportTermRecipientEvent(AddAwardReportTermRecipientRuleEvent addAwardReportTermRecipientRuleEvent)

This method...

Parameters:

addAwardReportTermRecipientRuleEvent -

Returns:

processAwardReportTermRecipientEvent

public boolean processAwardReportTermRecipientEvent(AwardReportTermRecipientRuleEvent event)

This method...

Parameters:

event -

Returns:

processAwardTemplateSyncRules

public boolean processAwardTemplateSyncRules(AwardTemplateSyncEvent awardTemplateSyncEvent)

Description copied from interface: AwardTemplateSyncRule

Rule invoked upon syncing an Award Template AwardTemplateSyncEvent

Specified by:

processAwardTemplateSyncRules in interface AwardTemplateSyncRule

Returns:

boolean

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)

processsAddAttachmentRule

public boolean processsAddAttachmentRule(AddAwardAttachmentEvent event)

Specified by:

processsAddAttachmentRule in interface AddAwardAttachmentRule

See Also:

AddAwardAttachmentRule.processsAddAttachmentRule(org.kuali.kra.award.rule.event.AddAwardAttachmentEvent)

reportAndCreateAuditCluster

protected void reportAndCreateAuditCluster()