org.kuali.kra.timeandmoney

Class TimeAndMoneyDocumentRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.timeandmoney.TimeAndMoneyDocumentRule

All Implemented Interfaces:

AwardDirectFandADistributionRule, TransactionRule, 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 TimeAndMoneyDocumentRule
extends ResearchDocumentRuleBase
implements TransactionRule, AwardDirectFandADistributionRule

Main Business Rule class for TimeAndMoneyDocument. 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.timeandmoney.transactions.TransactionRule

PENDING_TRANSACTION_ITEMS_LIST_ERROR_KEY

Constructor Summary

Constructors

Constructor and Description
TimeAndMoneyDocumentRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkReportTrackingValueChanges(TimeAndMoneyDocument timeAndMoneyDocument) This method determines if a change has occured that might change report tracking records.
protected ActivePendingTransactionsService	getActivePendingTransactionsService()
AwardVersionService	getAwardVersionService()
ReportTrackingService	getReportTrackingService()
boolean	processAddAwardDirectFandADistributionBusinessRules(AwardDirectFandADistributionRuleEvent awardDirectFandADistributionRuleEvent) This method processes must be implemented and enforces all add method business rules.
boolean	processAddPendingTransactionBusinessRules(AddTransactionRuleEvent event) This method is used to validate a new AwardPaymentSchedule to be added to an Award
boolean	processAwardDirectFandADistributionBusinessRules(AwardDirectFandADistributionRuleEvent awardDirectFandADistributionRuleEvent) This method processes must be implemented and enforces all add method business rules.
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processPendingTransactionBusinessRules(TransactionRuleEvent event) This method is used to validate AwardPaymentSchedule items in an Award
boolean	processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processSingleNodeTransactionBusinessRules(AwardHierarchyNode awardHierarchyNode, AwardAmountInfo aai)
boolean	processSingleNodeTransactionBusinessRules(AwardHierarchyNode awardHierarchyNode, AwardAmountInfo aai, TimeAndMoneyDocument doc)
protected void	reportAwardReportTrackingError(org.kuali.rice.krad.document.Document document) This method reports a warning when a change occurred that might change report tracking.

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

Field Detail

DOCUMENT_ERROR_PATH

public static final String DOCUMENT_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

AWARD_ERROR_PATH

public static final String AWARD_ERROR_PATH

See Also:

Constant Field Values

Constructor Detail

TimeAndMoneyDocumentRule

public TimeAndMoneyDocumentRule()

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:

org.kuali.core.rules.DocumentRuleBase#processCustomSaveDocumentBusinessRules( org.kuali.rice.krad.document.Document)

reportAwardReportTrackingError

protected void reportAwardReportTrackingError(org.kuali.rice.krad.document.Document document)

This method reports a warning when a change occurred that might change report tracking.

Parameters:

document -

checkReportTrackingValueChanges

protected boolean checkReportTrackingValueChanges(TimeAndMoneyDocument timeAndMoneyDocument)

This method determines if a change has occured that might change report tracking records.

Parameters:

timeAndMoneyDocument -

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)

processAddPendingTransactionBusinessRules

public boolean processAddPendingTransactionBusinessRules(AddTransactionRuleEvent event)

Description copied from interface: TransactionRule

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

Specified by:

processAddPendingTransactionBusinessRules in interface TransactionRule

Returns:

processPendingTransactionBusinessRules

public boolean processPendingTransactionBusinessRules(TransactionRuleEvent event)

Description copied from interface: TransactionRule

This method is used to validate AwardPaymentSchedule items in an Award

Specified by:

processPendingTransactionBusinessRules in interface TransactionRule

Returns:

processAddAwardDirectFandADistributionBusinessRules

public boolean processAddAwardDirectFandADistributionBusinessRules(AwardDirectFandADistributionRuleEvent awardDirectFandADistributionRuleEvent)

Description copied from interface: AwardDirectFandADistributionRule

This method processes must be implemented and enforces all add method business rules.

Specified by:

processAddAwardDirectFandADistributionBusinessRules in interface AwardDirectFandADistributionRule

Returns:

See Also:

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

processAwardDirectFandADistributionBusinessRules

public boolean processAwardDirectFandADistributionBusinessRules(AwardDirectFandADistributionRuleEvent awardDirectFandADistributionRuleEvent)

Description copied from interface: AwardDirectFandADistributionRule

This method processes must be implemented and enforces all add method business rules.

Specified by:

processAwardDirectFandADistributionBusinessRules in interface AwardDirectFandADistributionRule

Returns:

processSingleNodeTransactionBusinessRules

public boolean processSingleNodeTransactionBusinessRules(AwardHierarchyNode awardHierarchyNode,
                                                AwardAmountInfo aai)

processSingleNodeTransactionBusinessRules

public boolean processSingleNodeTransactionBusinessRules(AwardHierarchyNode awardHierarchyNode,
                                                AwardAmountInfo aai,
                                                TimeAndMoneyDocument doc)

Specified by:

processSingleNodeTransactionBusinessRules in interface TransactionRule

getReportTrackingService

public ReportTrackingService getReportTrackingService()

getActivePendingTransactionsService

protected ActivePendingTransactionsService getActivePendingTransactionsService()

getAwardVersionService

public AwardVersionService getAwardVersionService()