org.kuali.kfs.module.bc.document.validation.impl
Class BudgetConstructionRules

java.lang.Object
  org.kuali.kfs.module.bc.document.validation.impl.BudgetConstructionRules

All Implemented Interfaces:

AddBudgetConstructionDocumentRule<BudgetConstructionDocument>, AddPendingBudgetGeneralLedgerLineRule<BudgetConstructionDocument,PendingBudgetConstructionGeneralLedger>, BudgetExpansionRule, DeleteMonthlySpreadRule<BudgetConstructionDocument>, DeletePendingBudgetGeneralLedgerLineRule<BudgetConstructionDocument,PendingBudgetConstructionGeneralLedger>, SalarySettingRule, SaveMonthlyBudgetRule<BudgetConstructionDocument,BudgetConstructionMonthly>, org.kuali.rice.kns.rule.BusinessRule, org.kuali.rice.kns.rule.SaveDocumentRule

public class BudgetConstructionRules
extends Object
implements BudgetExpansionRule, SalarySettingRule, org.kuali.rice.kns.rule.SaveDocumentRule, AddBudgetConstructionDocumentRule<BudgetConstructionDocument>, AddPendingBudgetGeneralLedgerLineRule<BudgetConstructionDocument,PendingBudgetConstructionGeneralLedger>, DeletePendingBudgetGeneralLedgerLineRule<BudgetConstructionDocument,PendingBudgetConstructionGeneralLedger>, DeleteMonthlySpreadRule<BudgetConstructionDocument>, SaveMonthlyBudgetRule<BudgetConstructionDocument,BudgetConstructionMonthly>

Base rule class for Budget Construction. Handles calling other expansion rule classes and the core budget document rules.

Constructor Summary

BudgetConstructionRules()
Initialize expansion rule classes.

Method Summary

boolean	processAddAppointmentFunding(List<PendingBudgetConstructionAppointmentFunding> existingAppointmentFundings, PendingBudgetConstructionAppointmentFunding appointmentFunding) process the rules before the given appointment funding is created
boolean	processAddBudgetConstructionDocumentRules(BudgetConstructionDocument budgetConstructionDocument) Processes all the rules for this event and returns true if all rules passed
boolean	processAddPendingBudgetGeneralLedgerLineRules(BudgetConstructionDocument budgetConstructionDocument, PendingBudgetConstructionGeneralLedger pendingBudgetConstructionGeneralLedger, boolean isRevenue) Processes all the rules for this event and returns true if all rules passed
boolean	processAdjustSalaraySettingLinePercent(PendingBudgetConstructionAppointmentFunding appointmentFunding) process the rules before adjusting the salary amount of the given appointment funding
boolean	processDeleteMonthlySpreadRules(BudgetConstructionDocument budgetConstructionDocument, BCConstants.MonthSpreadDeleteType monthSpreadDeleteType)
boolean	processDeletePendingBudgetGeneralLedgerLineRules(BudgetConstructionDocument budgetConstructionDocument, PendingBudgetConstructionGeneralLedger pendingBudgetConstructionGeneralLedger, boolean isRevenue) Processes all the rules for this event and returns true if all rules passed
boolean	processExpansionRule(BudgetExpansionEvent budgetExpansionEvent) Process an expansion event.
boolean	processNormalizePayrateAndAmount(PendingBudgetConstructionAppointmentFunding appointmentFunding) process the rules before the pay rate and salary amount of the given appointment funding can be normalized
boolean	processQuickSaveAppointmentFunding(PendingBudgetConstructionAppointmentFunding appointmentFunding) process the rules before the given appointment funding is saved
boolean	processSaveAppointmentFunding(PendingBudgetConstructionAppointmentFunding appointmentFunding) process the rules before the given appointment funding is saved
boolean	processSaveDocument(org.kuali.rice.kns.document.Document document)
boolean	processSaveMonthlyBudgetRules(BudgetConstructionDocument budgetConstructionDocument, BudgetConstructionMonthly budgetConstructionMonthly) Processes all the rules for this event and returns true if all rules passed

Methods inherited from class java.lang.Object

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

Constructor Detail

BudgetConstructionRules

public BudgetConstructionRules()

Initialize expansion rule classes.

Method Detail

processExpansionRule

public boolean processExpansionRule(BudgetExpansionEvent budgetExpansionEvent)

Description copied from interface: BudgetExpansionRule

Process an expansion event.

Specified by:

processExpansionRule in interface BudgetExpansionRule

Parameters:

budgetExpansionEvent - event to process

Returns:

boolean true if validation was successful, false if errors were encountered

See Also:

BudgetExpansionRule.processExpansionRule(org.kuali.kfs.module.bc.document.validation.event.BudgetExpansionEvent)

processSaveDocument

public boolean processSaveDocument(org.kuali.rice.kns.document.Document document)

Specified by:

processSaveDocument in interface org.kuali.rice.kns.rule.SaveDocumentRule

See Also:

SaveDocumentRule.processSaveDocument(org.kuali.rice.kns.document.Document)

processAddBudgetConstructionDocumentRules

public boolean processAddBudgetConstructionDocumentRules(BudgetConstructionDocument budgetConstructionDocument)

Description copied from interface: AddBudgetConstructionDocumentRule

Processes all the rules for this event and returns true if all rules passed

Specified by:

processAddBudgetConstructionDocumentRules in interface AddBudgetConstructionDocumentRule<BudgetConstructionDocument>

Returns:

See Also:

AddBudgetConstructionDocumentRule.processAddBudgetConstructionDocumentRules(org.kuali.kfs.module.bc.document.BudgetConstructionDocument)

processAddPendingBudgetGeneralLedgerLineRules

public boolean processAddPendingBudgetGeneralLedgerLineRules(BudgetConstructionDocument budgetConstructionDocument,
                                                             PendingBudgetConstructionGeneralLedger pendingBudgetConstructionGeneralLedger,
                                                             boolean isRevenue)

Description copied from interface: AddPendingBudgetGeneralLedgerLineRule

Processes all the rules for this event and returns true if all rules passed

Specified by:

processAddPendingBudgetGeneralLedgerLineRules in interface AddPendingBudgetGeneralLedgerLineRule<BudgetConstructionDocument,PendingBudgetConstructionGeneralLedger>

Returns:

See Also:

AddPendingBudgetGeneralLedgerLineRule.processAddPendingBudgetGeneralLedgerLineRules(org.kuali.kfs.module.bc.document.BudgetConstructionDocument, org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionGeneralLedger, boolean)

processDeletePendingBudgetGeneralLedgerLineRules

public boolean processDeletePendingBudgetGeneralLedgerLineRules(BudgetConstructionDocument budgetConstructionDocument,
                                                                PendingBudgetConstructionGeneralLedger pendingBudgetConstructionGeneralLedger,
                                                                boolean isRevenue)

Description copied from interface: DeletePendingBudgetGeneralLedgerLineRule

Processes all the rules for this event and returns true if all rules passed

Specified by:

processDeletePendingBudgetGeneralLedgerLineRules in interface DeletePendingBudgetGeneralLedgerLineRule<BudgetConstructionDocument,PendingBudgetConstructionGeneralLedger>

Returns:

See Also:

DeletePendingBudgetGeneralLedgerLineRule.processDeletePendingBudgetGeneralLedgerLineRules(org.kuali.kfs.module.bc.document.BudgetConstructionDocument, org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionGeneralLedger, boolean)

processDeleteMonthlySpreadRules

public boolean processDeleteMonthlySpreadRules(BudgetConstructionDocument budgetConstructionDocument,
                                               BCConstants.MonthSpreadDeleteType monthSpreadDeleteType)

Specified by:

processDeleteMonthlySpreadRules in interface DeleteMonthlySpreadRule<BudgetConstructionDocument>

See Also:

DeleteMonthlySpreadRule.processDeleteMonthlySpreadRules(org.kuali.kfs.module.bc.document.BudgetConstructionDocument, org.kuali.kfs.module.bc.BCConstants.MonthSpreadDeleteType)

processSaveMonthlyBudgetRules

public boolean processSaveMonthlyBudgetRules(BudgetConstructionDocument budgetConstructionDocument,
                                             BudgetConstructionMonthly budgetConstructionMonthly)

Description copied from interface: SaveMonthlyBudgetRule

Processes all the rules for this event and returns true if all rules passed

Specified by:

processSaveMonthlyBudgetRules in interface SaveMonthlyBudgetRule<BudgetConstructionDocument,BudgetConstructionMonthly>

Returns:

processAddAppointmentFunding

public boolean processAddAppointmentFunding(List<PendingBudgetConstructionAppointmentFunding> existingAppointmentFundings,
                                            PendingBudgetConstructionAppointmentFunding appointmentFunding)

Description copied from interface: SalarySettingRule

process the rules before the given appointment funding is created

Specified by:

processAddAppointmentFunding in interface SalarySettingRule

Parameters:

existingAppointmentFundings - the existing appointment fundings

appointmentFunding - the given appointment funding

Returns:

true if the appointment funding can pass all rule before created, otherwise, false

See Also:

org.kuali.kfs.module.bc.document.validation.SalarySettingRule#processAddAppointmentFunding(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding)

processSaveAppointmentFunding

public boolean processSaveAppointmentFunding(PendingBudgetConstructionAppointmentFunding appointmentFunding)

Description copied from interface: SalarySettingRule

process the rules before the given appointment funding is saved

Specified by:

processSaveAppointmentFunding in interface SalarySettingRule

Parameters:

appointmentFunding - the given appointment funding

Returns:

true if the appointment funding can pass all rule before saved, otherwise, false

See Also:

SalarySettingRule.processSaveAppointmentFunding(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding)

processNormalizePayrateAndAmount

public boolean processNormalizePayrateAndAmount(PendingBudgetConstructionAppointmentFunding appointmentFunding)

Description copied from interface: SalarySettingRule

process the rules before the pay rate and salary amount of the given appointment funding can be normalized

Specified by:

processNormalizePayrateAndAmount in interface SalarySettingRule

Parameters:

appointmentFunding - the given appointment funding

Returns:

true if the appointment funding can pass all rule before normalizing, otherwise, false

See Also:

SalarySettingRule.processNormalizePayrateAndAmount(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding)

processAdjustSalaraySettingLinePercent

public boolean processAdjustSalaraySettingLinePercent(PendingBudgetConstructionAppointmentFunding appointmentFunding)

Description copied from interface: SalarySettingRule

process the rules before adjusting the salary amount of the given appointment funding

Specified by:

processAdjustSalaraySettingLinePercent in interface SalarySettingRule

Parameters:

appointmentFunding - the given appointment funding

Returns:

true if the appointment funding can pass all rule before adjusting, otherwise, false

See Also:

SalarySettingRule.processAdjustSalaraySettingLinePercent(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding)

processQuickSaveAppointmentFunding

public boolean processQuickSaveAppointmentFunding(PendingBudgetConstructionAppointmentFunding appointmentFunding)

Description copied from interface: SalarySettingRule

process the rules before the given appointment funding is saved

Specified by:

processQuickSaveAppointmentFunding in interface SalarySettingRule

Parameters:

appointmentFunding - the given appointment funding

Returns:

true if the appointment funding can pass all rule before saved, otherwise, false

See Also:

SalarySettingRule.processQuickSaveAppointmentFunding(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding)