org.kuali.kra.award

Class AwardTermsAuditRule

java.lang.Object

org.kuali.kra.award.AwardTermsAuditRule

All Implemented Interfaces:

org.kuali.rice.krad.rules.rule.BusinessRule, org.kuali.rice.krad.rules.rule.DocumentAuditRule

public class AwardTermsAuditRule
extends Object
implements org.kuali.rice.krad.rules.rule.DocumentAuditRule

This class processes audit rules (warnings) for the Terms Information related data of the AwardDocument.

Constructor Summary

Constructors

Constructor and Description
AwardTermsAuditRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addErrorToAuditErrors(String description) This method creates and adds the Audit Error to the List auditError.
protected List<org.kuali.rice.core.api.util.KeyValue>	getSponsorTermTypesFromDatabase() This method gets the list of Sponsor Term Types from the database.
protected boolean	isSponsorTermTypeInAwardSponsorTerms(String key, List<AwardSponsorTerm> awardSponsorTerms) This method tests if there is an Award Sponsor Term with Sponsor Term Type Code that is equal to the parameter "key".
boolean	processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)
protected void	reportAndCreateAuditCluster() This method creates and adds the AuditCluster to the Global AuditErrorMap.
protected void	setSponsorTermTypes() This method checks if sponsorTermTypes is null if true sets the list to a list of database return from getSponsorTermTypesFromDatabase()
protected void	setSponsorTermTypes(List<org.kuali.rice.core.api.util.KeyValue> sponsorTermTypes) This method sets sponsor term types to List argument.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AwardTermsAuditRule

public AwardTermsAuditRule()

Method Detail

processRunAuditBusinessRules

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

Specified by:

processRunAuditBusinessRules in interface org.kuali.rice.krad.rules.rule.DocumentAuditRule

See Also:

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

setSponsorTermTypes

protected void setSponsorTermTypes()

This method checks if sponsorTermTypes is null if true sets the list to a list of database return from getSponsorTermTypesFromDatabase()

setSponsorTermTypes

protected void setSponsorTermTypes(List<org.kuali.rice.core.api.util.KeyValue> sponsorTermTypes)

This method sets sponsor term types to List argument.

Parameters:

sponsorTermTypes -

isSponsorTermTypeInAwardSponsorTerms

protected boolean isSponsorTermTypeInAwardSponsorTerms(String key,
                                           List<AwardSponsorTerm> awardSponsorTerms)

This method tests if there is an Award Sponsor Term with Sponsor Term Type Code that is equal to the parameter "key".

Parameters:

key -

awardSponsorTerms -

Returns:

addErrorToAuditErrors

protected void addErrorToAuditErrors(String description)

This method creates and adds the Audit Error to the List auditError.

Parameters:

description -

reportAndCreateAuditCluster

protected void reportAndCreateAuditCluster()

This method creates and adds the AuditCluster to the Global AuditErrorMap.

getSponsorTermTypesFromDatabase

protected List<org.kuali.rice.core.api.util.KeyValue> getSponsorTermTypesFromDatabase()

This method gets the list of Sponsor Term Types from the database.

Parameters:

-