org.kuali.kfs.module.bc.document.service
Interface BudgetConstructionRuleHelperService

All Known Implementing Classes:

BudgetConstructionRuleHelperServiceImpl

public interface BudgetConstructionRuleHelperService

define a set of validations methods for buddget construction

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

Method Detail

hasDetailPositionRequiredObjectCode

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

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

hasValidAccount

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

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

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

hasValidChart

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

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

hasValidIncumbent

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

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

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

hasValidObjectCode

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

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

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

hasValidPosition

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

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

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

hasValidSubAccount

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

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

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

hasValidSubObjectCode

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

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

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

isAssociatedWithValidDocument

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

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

isBudgetableDocument

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

determine wether the given budget document is allowed to be budgeted

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

isDetailPositionRequiredObjectCode

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

determine whether the given object requires a detail position

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

isFieldFormatValid

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

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

isValidAccount

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

determine whether the given account is valid

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

isValidChart

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

determine whether the given chart is valid

Parameters:

chart - the given chart

invalidValue - 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 chart is valid; otherwise, false

isValidIncumbent

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

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

isValidObjectCode

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

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

isValidPosition

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

determine whether the given budget contruction position is valid

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

isValidSubAccount

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

determine whether the given sub account is valid

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

isValidSubObjectCode

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

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