org.kuali.kfs.module.bc.document.service.impl
Class BudgetConstructionRuleHelperServiceImpl

java.lang.Object
  org.kuali.kfs.module.bc.document.service.impl.BudgetConstructionRuleHelperServiceImpl

All Implemented Interfaces:

BudgetConstructionRuleHelperService

public class BudgetConstructionRuleHelperServiceImpl
extends Object
implements BudgetConstructionRuleHelperService

implementing the validation methods defined in BudgetConstructionRuleHelperService

Constructor Summary

BudgetConstructionRuleHelperServiceImpl()

Method Summary

boolean	hasDetailPositionRequiredObjectCode(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) test if the given appointment funding is associted with a labor detail allowed object
boolean	hasValidAccount(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) test if the given appointment funding is associted with a valid account
boolean	hasValidChart(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) test if the given appointment funding is associted with a valid chart of accounts
boolean	hasValidIncumbent(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) test if the given appointment funding is associted with a valid incumbent
boolean	hasValidObjectCode(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) test if the given appointment funding is associted with a valid financial object
boolean	hasValidPosition(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) test if the given appointment funding is associted with a valid budget position
boolean	hasValidSubAccount(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) test if the given appointment funding is associted with a valid sub account
boolean	hasValidSubObjectCode(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) test if the given appointment funding is associted with a valid sub object
boolean	isAssociatedWithValidDocument(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap, String errorPropertyName) determine whether the given appoinment funding can be associated with a valid budget contruction document
boolean	isBudgetableDocument(BudgetConstructionDocument budgetConstructionDocument, org.kuali.rice.kns.util.MessageMap errorMap, String errorPropertyName) determine wether the given budget document is allowed to be budgeted
boolean	isDetailPositionRequiredObjectCode(ObjectCode financialObject, String currentValue, org.kuali.rice.kns.util.MessageMap errorMap, String errorPropertyName) determine whether the given object requires a detail position
boolean	isFieldFormatValid(PendingBudgetConstructionAppointmentFunding appointmentFunding, org.kuali.rice.kns.util.MessageMap errorMap) determine if the fields in the given appointment funding line are in the correct formats defined in the data dictionary
boolean	isValidAccount(Account account, String currentValue, org.kuali.rice.kns.util.MessageMap errorMap, String errorPropertyName) determine whether the given account is valid
boolean	isValidChart(Chart chart, String currentValue, org.kuali.rice.kns.util.MessageMap errorMap, String errorPropertyName) determine whether the given chart is valid
boolean	isValidIncumbent(BudgetConstructionIntendedIncumbent intendedIncumbent, String currentValue, org.kuali.rice.kns.util.MessageMap errorMap, String errorPropertyName) determine whether the given budget contruction intended incumbent is valid
boolean	isValidObjectCode(ObjectCode objectCode, String currentValue, org.kuali.rice.kns.util.MessageMap errorMap, String errorPropertyName) Runs existence and active tests on the ObjectCode reference This method is differenct than the one in AccountingLineRuleHelper in that it adds the bad value to the errormessage This method signature should probably be added to AccountingLineRuleHelper
boolean	isValidPosition(BudgetConstructionPosition position, String currentValue, org.kuali.rice.kns.util.MessageMap errorMap, String errorPropertyName) determine whether the given budget contruction position is valid
boolean	isValidSubAccount(SubAccount subAccount, String currentValue, org.kuali.rice.kns.util.MessageMap errorMap, String errorPropertyName) determine whether the given sub account is valid
boolean	isValidSubObjectCode(SubObjectCode subObjectCode, String currentValue, org.kuali.rice.kns.util.MessageMap errorMap, String errorPropertyName) Runs existence and active tests on the SubObjectCode reference This method is differenct than the one in AccountingLineRuleHelper in that it adds the bad value to the errormessage This method signature should probably be added to AccountingLineRuleHelper
void	setBudgetDocumentService(BudgetDocumentService budgetDocumentService) Sets the budgetDocumentService attribute value.
void	setDictionaryValidationService(org.kuali.rice.kns.service.DictionaryValidationService dictionaryValidationService) Sets the dictionaryValidationService attribute value.
void	setLaborModuleService(LaborModuleService laborModuleService) Sets the laborModuleService attribute value.

Methods inherited from class java.lang.Object

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

Constructor Detail

BudgetConstructionRuleHelperServiceImpl

public BudgetConstructionRuleHelperServiceImpl()

Method Detail

hasDetailPositionRequiredObjectCode

public boolean hasDetailPositionRequiredObjectCode(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                                   org.kuali.rice.kns.util.MessageMap errorMap)

Description copied from interface: BudgetConstructionRuleHelperService

test if the given appointment funding is associted with a labor detail allowed object

Specified by:

hasDetailPositionRequiredObjectCode in interface BudgetConstructionRuleHelperService

Parameters:

appointmentFunding - the given appointment funding

errorMap - the error map that contains errors if any

Returns:

true if the given appointment funding is associted with a labor detail allowed object; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.BudgetConstructionRuleHelperService#hasDetailPositionRequiredObjectCode(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding, org.kuali.core.util.ErrorMap)

hasValidAccount

public boolean hasValidAccount(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                               org.kuali.rice.kns.util.MessageMap errorMap)

Description copied from interface: BudgetConstructionRuleHelperService

test if the given appointment funding is associted with a valid account

Specified by:

hasValidAccount in interface BudgetConstructionRuleHelperService

Parameters:

appointmentFunding - the given appointment funding

errorMap - the error map that contains errors if any

Returns:

true if the given appointment funding is associted with a valid account; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.BudgetConstructionRuleHelperService#hasValidAccount(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding, org.kuali.core.util.ErrorMap)

hasValidChart

public boolean hasValidChart(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                             org.kuali.rice.kns.util.MessageMap errorMap)

Description copied from interface: BudgetConstructionRuleHelperService

test if the given appointment funding is associted with a valid chart of accounts

Specified by:

hasValidChart in interface BudgetConstructionRuleHelperService

Parameters:

appointmentFunding - the given appointment funding

errorMap - the error map that contains errors if any

Returns:

true if the given appointment funding is associted with a valid chart of accounts; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.BudgetConstructionRuleHelperService#hasValidChart(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding, org.kuali.core.util.ErrorMap)

hasValidIncumbent

public boolean hasValidIncumbent(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                 org.kuali.rice.kns.util.MessageMap errorMap)

Description copied from interface: BudgetConstructionRuleHelperService

test if the given appointment funding is associted with a valid incumbent

Specified by:

hasValidIncumbent in interface BudgetConstructionRuleHelperService

Parameters:

appointmentFunding - the given appointment funding

errorMap - the error map that contains errors if any

Returns:

true if the given appointment funding is associted with a valid incumbent; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.BudgetConstructionRuleHelperService#hasValidIncumbent(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding, org.kuali.core.util.ErrorMap)

hasValidObjectCode

public boolean hasValidObjectCode(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                  org.kuali.rice.kns.util.MessageMap errorMap)

Description copied from interface: BudgetConstructionRuleHelperService

test if the given appointment funding is associted with a valid financial object

Specified by:

hasValidObjectCode in interface BudgetConstructionRuleHelperService

Parameters:

appointmentFunding - the given appointment funding

errorMap - the error map that contains errors if any

Returns:

true if the given appointment funding is associted with a valid financial object; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.BudgetConstructionRuleHelperService#hasValidObjectCode(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding, org.kuali.core.util.ErrorMap)

hasValidPosition

public boolean hasValidPosition(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                org.kuali.rice.kns.util.MessageMap errorMap)

Description copied from interface: BudgetConstructionRuleHelperService

test if the given appointment funding is associted with a valid budget position

Specified by:

hasValidPosition in interface BudgetConstructionRuleHelperService

Parameters:

appointmentFunding - the given appointment funding

errorMap - the error map that contains errors if any

Returns:

true if the given appointment funding is associted with a valid budget position; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.BudgetConstructionRuleHelperService#hasValidPosition(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding, org.kuali.core.util.ErrorMap)

hasValidSubAccount

public boolean hasValidSubAccount(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                  org.kuali.rice.kns.util.MessageMap errorMap)

Description copied from interface: BudgetConstructionRuleHelperService

test if the given appointment funding is associted with a valid sub account

Specified by:

hasValidSubAccount in interface BudgetConstructionRuleHelperService

Parameters:

appointmentFunding - the given appointment funding

errorMap - the error map that contains errors if any

Returns:

true if the given appointment funding is associted with a valid sub account; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.BudgetConstructionRuleHelperService#hasValidSubAccount(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding, org.kuali.core.util.ErrorMap)

hasValidSubObjectCode

public boolean hasValidSubObjectCode(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                     org.kuali.rice.kns.util.MessageMap errorMap)

Description copied from interface: BudgetConstructionRuleHelperService

test if the given appointment funding is associted with a valid sub object

Specified by:

hasValidSubObjectCode in interface BudgetConstructionRuleHelperService

Parameters:

appointmentFunding - the given appointment funding

errorMap - the error map that contains errors if any

Returns:

true if the given appointment funding is associted with a valid sub object; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.BudgetConstructionRuleHelperService#hasValidSubObjectCode(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding, org.kuali.core.util.ErrorMap)

isAssociatedWithValidDocument

public boolean isAssociatedWithValidDocument(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                             org.kuali.rice.kns.util.MessageMap errorMap,
                                             String errorPropertyName)

Description copied from interface: BudgetConstructionRuleHelperService

determine whether the given appoinment funding can be associated with a valid budget contruction document

Specified by:

isAssociatedWithValidDocument in interface BudgetConstructionRuleHelperService

Parameters:

appointmentFunding - the given appointment funding

errorMap - the given error map that can hold the error message if any

errorPropertyName - the specified property name that is tested

Returns:

true if the given appoinment funding can be associated with a valid budget contruction document; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.impl.BudgetConstructionRuleHelperService#isAssociatedWithValidDocument(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding, org.kuali.core.util.ErrorMap, java.lang.String)

isBudgetableDocument

public boolean isBudgetableDocument(BudgetConstructionDocument budgetConstructionDocument,
                                    org.kuali.rice.kns.util.MessageMap errorMap,
                                    String errorPropertyName)

Description copied from interface: BudgetConstructionRuleHelperService

determine wether the given budget document is allowed to be budgeted

Specified by:

isBudgetableDocument in interface BudgetConstructionRuleHelperService

Parameters:

budgetConstructionDocument - the given budget document

errorMap - the given error map that can hold the error message if any

errorPropertyName - the specified property name that is tested

Returns:

true if the given budget document can be budgeted; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.impl.BudgetConstructionRuleHelperService#isBudgetableDocument(org.kuali.kfs.module.bc.document.BudgetConstructionDocument, org.kuali.core.util.ErrorMap, java.lang.String)

isDetailPositionRequiredObjectCode

public boolean isDetailPositionRequiredObjectCode(ObjectCode financialObject,
                                                  String currentValue,
                                                  org.kuali.rice.kns.util.MessageMap errorMap,
                                                  String errorPropertyName)

Description copied from interface: BudgetConstructionRuleHelperService

determine whether the given object requires a detail position

Specified by:

isDetailPositionRequiredObjectCode in interface BudgetConstructionRuleHelperService

Parameters:

financialObject - the given financial object

currentValue - the given current value

errorMap - the given error map that can hold the error message if any

errorPropertyName - the specified property name that is tested

Returns:

true if the given object requires a detail position; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.BudgetConstructionRuleHelperService#isDetailPositionRequiredObjectCode(org.kuali.kfs.coa.businessobject.ObjectCode, java.lang.String, org.kuali.core.util.ErrorMap, java.lang.String)

isFieldFormatValid

public boolean isFieldFormatValid(PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                  org.kuali.rice.kns.util.MessageMap errorMap)

Description copied from interface: BudgetConstructionRuleHelperService

determine if the fields in the given appointment funding line are in the correct formats defined in the data dictionary

Specified by:

isFieldFormatValid in interface BudgetConstructionRuleHelperService

Parameters:

appointmentFunding - the given appointment funding

errorMap - the given error map that can hold the error message if any

Returns:

true if the fields in the given appointment funding line are in the correct formats defined in the data dictionary; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.BudgetConstructionRuleHelperService#isFieldFormatValid(org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionAppointmentFunding, org.kuali.core.util.ErrorMap)

isValidAccount

public boolean isValidAccount(Account account,
                              String currentValue,
                              org.kuali.rice.kns.util.MessageMap errorMap,
                              String errorPropertyName)

Description copied from interface: BudgetConstructionRuleHelperService

determine whether the given account is valid

Specified by:

isValidAccount in interface BudgetConstructionRuleHelperService

Parameters:

account - the given account

currentValue - the given current value

errorMap - the given error map that can hold the error message if any

errorPropertyName - the specified property name that is tested

Returns:

true if the given account is valid; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.impl.BudgetConstructionRuleHelperService#isValidAccount(org.kuali.kfs.coa.businessobject.Account, java.lang.String, org.kuali.core.util.ErrorMap, java.lang.String)

isValidChart

public boolean isValidChart(Chart chart,
                            String currentValue,
                            org.kuali.rice.kns.util.MessageMap errorMap,
                            String errorPropertyName)

Description copied from interface: BudgetConstructionRuleHelperService

determine whether the given chart is valid

Specified by:

isValidChart in interface BudgetConstructionRuleHelperService

Parameters:

chart - the given chart

errorMap - the given error map that can hold the error message if any

errorPropertyName - the specified property name that is tested

Returns:

true if the given chart is valid; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.impl.BudgetConstructionRuleHelperService#isValidChart(org.kuali.kfs.coa.businessobject.Chart, java.lang.String, org.kuali.core.util.ErrorMap, java.lang.String)

isValidIncumbent

public boolean isValidIncumbent(BudgetConstructionIntendedIncumbent intendedIncumbent,
                                String currentValue,
                                org.kuali.rice.kns.util.MessageMap errorMap,
                                String errorPropertyName)

Description copied from interface: BudgetConstructionRuleHelperService

determine whether the given budget contruction intended incumbent is valid

Specified by:

isValidIncumbent in interface BudgetConstructionRuleHelperService

Parameters:

intendedIncumbent - the given budget contruction intended incumbent

currentValue - the given current value

errorMap - the given error map that can hold the error message if any

errorPropertyName - the specified property name that is tested

Returns:

true if the given budget contruction intended incumbent is valid; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.impl.BudgetConstructionRuleHelperService#isValidIncumbent(org.kuali.kfs.module.bc.businessobject.BudgetConstructionIntendedIncumbent, java.lang.String, org.kuali.core.util.ErrorMap, java.lang.String)

isValidObjectCode

public boolean isValidObjectCode(ObjectCode objectCode,
                                 String currentValue,
                                 org.kuali.rice.kns.util.MessageMap errorMap,
                                 String errorPropertyName)

Description copied from interface: BudgetConstructionRuleHelperService

Runs existence and active tests on the ObjectCode reference This method is differenct than the one in AccountingLineRuleHelper in that it adds the bad value to the errormessage This method signature should probably be added to AccountingLineRuleHelper

Specified by:

isValidObjectCode in interface BudgetConstructionRuleHelperService

Parameters:

objectCode - the given object code

currentValue - the given current value

errorMap - the given error map that can hold the error message if any

errorPropertyName - the specified property name that is tested

Returns:

true if the given object code is valid; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.impl.BudgetConstructionRuleHelperService#isValidObjectCode(org.kuali.kfs.coa.businessobject.ObjectCode, java.lang.String, org.kuali.core.util.ErrorMap, java.lang.String)

isValidPosition

public boolean isValidPosition(BudgetConstructionPosition position,
                               String currentValue,
                               org.kuali.rice.kns.util.MessageMap errorMap,
                               String errorPropertyName)

Description copied from interface: BudgetConstructionRuleHelperService

determine whether the given budget contruction position is valid

Specified by:

isValidPosition in interface BudgetConstructionRuleHelperService

Parameters:

position - the given budget contruction position

currentValue - the given current value

errorMap - the given error map that can hold the error message if any

errorPropertyName - the specified property name that is tested

Returns:

true if the given budget contruction position is valid; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.impl.BudgetConstructionRuleHelperService#isValidPosition(org.kuali.kfs.module.bc.businessobject.BudgetConstructionPosition, java.lang.String, org.kuali.core.util.ErrorMap, java.lang.String)

isValidSubAccount

public boolean isValidSubAccount(SubAccount subAccount,
                                 String currentValue,
                                 org.kuali.rice.kns.util.MessageMap errorMap,
                                 String errorPropertyName)

Description copied from interface: BudgetConstructionRuleHelperService

determine whether the given sub account is valid

Specified by:

isValidSubAccount in interface BudgetConstructionRuleHelperService

Parameters:

subAccount - the given sub account

currentValue - the given current value

errorMap - the given error map that can hold the error message if any

errorPropertyName - the specified property name that is tested

Returns:

true if the given sub account is valid; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.impl.BudgetConstructionRuleHelperService#isValidSubAccount(org.kuali.kfs.coa.businessobject.SubAccount, java.lang.String, org.kuali.core.util.ErrorMap, java.lang.String)

isValidSubObjectCode

public boolean isValidSubObjectCode(SubObjectCode subObjectCode,
                                    String currentValue,
                                    org.kuali.rice.kns.util.MessageMap errorMap,
                                    String errorPropertyName)

Description copied from interface: BudgetConstructionRuleHelperService

Runs existence and active tests on the SubObjectCode reference This method is differenct than the one in AccountingLineRuleHelper in that it adds the bad value to the errormessage This method signature should probably be added to AccountingLineRuleHelper

Specified by:

isValidSubObjectCode in interface BudgetConstructionRuleHelperService

Parameters:

subObjectCode - the given sub object

currentValue - the given current value

errorMap - the given error map that can hold the error message if any

errorPropertyName - the specified property name that is tested

Returns:

true if the given sub object is valid; otherwise, false

See Also:

org.kuali.kfs.module.bc.document.service.impl.BudgetConstructionRuleHelperService#isValidSubObjectCode(org.kuali.kfs.coa.businessobject.SubObjCd, java.lang.String, org.kuali.core.util.ErrorMap, java.lang.String)

setBudgetDocumentService

public void setBudgetDocumentService(BudgetDocumentService budgetDocumentService)

Sets the budgetDocumentService attribute value.

Parameters:

budgetDocumentService - The budgetDocumentService to set.

setDictionaryValidationService

public void setDictionaryValidationService(org.kuali.rice.kns.service.DictionaryValidationService dictionaryValidationService)

Sets the dictionaryValidationService attribute value.

Parameters:

dictionaryValidationService - The dictionaryValidationService to set.

setLaborModuleService

public void setLaborModuleService(LaborModuleService laborModuleService)

Sets the laborModuleService attribute value.

Parameters:

laborModuleService - The laborModuleService to set.