org.kuali.kra.budget.core

Class BudgetServiceImpl<T extends BudgetParent>

java.lang.Object

org.kuali.kra.budget.core.BudgetServiceImpl<T>

All Implemented Interfaces:

BudgetService<T>

public class BudgetServiceImpl<T extends BudgetParent>
extends Object
implements BudgetService<T>

This class implements methods specified by BudgetDocumentService interface

Constructor Summary

Constructors

Constructor and Description
BudgetServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
BudgetDocument<T>	addBudgetVersion(BudgetParentDocument<T> document, String versionName) Service method for adding a BudgetVersionOverview to a ProposalDevelopmentDocument.
protected boolean	applyAuditRuleForBudgetDocument(BudgetVersionOverview budgetVersion)
boolean	checkActivityTypeChange(BudgetParentDocument<T> budgetParentDoc, Budget budget) This method check if activity type changed, then display confirmation message on 'open' budget version.
boolean	checkActivityTypeChange(Collection<BudgetRate> allPropRates, String activityTypeCode) This method checks if activity type changed, then display confirmation message on 'open' budget version.
BudgetDocument	copyBudgetVersion(BudgetDocument budgetDocument, boolean onlyOnePeriod) Returns a new finalized BudgetDocument with the data from the given BudgetDocument copied over.
protected void	copyLineItemToPersonnelDetails(BudgetDocument budgetDocument) Do this so that new personnel details(or copied ones) can be calculated
protected void	fixProperty(Object object, String methodName, Class clazz, Object propertyValue, Map<String,Object> objectMap) Recurse through all of the BOs and if a BO has a ProposalNumber property, set its value to the new proposal number.
String	getActivityTypeForBudget(BudgetDocument<T> budgetDocument)
List<ValidCeJobCode>	getApplicableCostElements(Long budgetId, String personSequenceNumber) This method returns the applicable Object Codes (Cost Elements) for a given Budget Person based on his Job Code
String	getApplicableCostElementsForAjaxCall(Long budgetId, String personSequenceNumber, String budgetCategoryTypeCode) This method returns the applicable Object Codes (Cost Elements) for a given Budget Person, converted to string separated by ",".
BudgetDecimal	getBaseSalaryByPeriod(Long budgetId, int budgetPeriod, KeyPersonInfo person)
protected BudgetCommonService<BudgetParent>	getBudgetCommonService(BudgetParentDocument parentBudgetDocument)
String	getBudgetExpensePanelName(BudgetPeriod budgetPeriod, BudgetLineItem budgetLineItem) This method returns the Non-Personnel Panel Name (based on the variables).
protected BudgetPersonService	getBudgetPersonService()
BudgetRatesService<T>	getBudgetRatesService() Gets the budgetRatesService attribute.
BudgetSummaryService	getBudgetSummaryService() Gets the budgetSummaryService attribute.
BudgetVersionRule	getBudgetVersionRule() Retrieve injected AddBudgetVersionRule singleton
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
DeepCopyPostProcessor	getDeepCopyPostProcessor() Gets the deepCopyPostProcessor attribute.
protected org.kuali.rice.krad.service.DocumentService	getDocumentService()
List<String>	getExistingGroupNames(String budgetId, String budgetPeriod) This method returns the existing Personnel Line Item Group Names based on his Job Code
String	getExistingGroupNamesForAjaxCall(String budgetId, String budgetPeriod) This method returns the existing Personnel Line Item Group Names , converted to string separated by ",".
FiscalYearMonthService	getFiscalYearMonthService()
protected List<String>	getFormulatedCostElements()
List<BudgetLineItem>	getMatchingLineItems(List<BudgetLineItem> lineItems, List<String> budgetCategoryType)
protected BudgetDocument<T>	getNewBudgetVersion(BudgetParentDocument<T> parentDocument, String versionName)
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
String	getParticipantSupportCategoryCode()
org.kuali.rice.krad.service.PessimisticLockService	getPessimisticLockService() Retrieve injected PessimisticLockService singleton
Collection<BudgetRate>	getSavedBudgetRates(Budget budget) This method returns the saved Proposal Rates collection.
Collection<BudgetRate>	getSavedProposalRates(BudgetVersionOverview budgetToOpen)
protected boolean	isBudgetFormulatedCostEnabled()
boolean	isBudgetVersionNameValid(BudgetParentDocument<T> document, String name) Runs business rules on the given name of a BudgetVersionOverview instance and ProposalDevelopmentDocument instance to determine if it is ok to add a BudgetVersionOverview instance to a BudgetDocument instance.
protected boolean	isPropertyGetterMethod(Method method, Method[] methods) Is the given method a getter method for a property? Must conform to the following: Must start with the get Must have a corresponding setter method Must have zero arguments.
String	populateBudgetPersonSalaryDetailsInPeriods(String budgetId, String personSequenceNumber, String personId)
void	populateNewBudgetLineItem(BudgetLineItem newBudgetLineItem, BudgetPeriod budgetPeriod)
protected void	saveBudgetDocument(BudgetDocument<T> budgetDocument) This method...
void	setBudgetPersonService(BudgetPersonService budgetPersonService)
void	setBudgetRatesService(BudgetRatesService<T> budgetRatesService) Sets the budgetRatesService attribute value.
void	setBudgetSummaryService(BudgetSummaryService budgetSummaryService) Sets the budgetSummaryService attribute value.
void	setBudgetVersionRule(BudgetVersionRule budgetVersionRule) Inject AddBudgetVersionRule singleton
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDeepCopyPostProcessor(DeepCopyPostProcessor deepCopyPostProcessor) Sets the deepCopyPostProcessor attribute value.
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setFiscalYearMonthService(FiscalYearMonthService fiscalYearMonthService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService) Sets the ParameterService.
void	setPessimisticLockService(org.kuali.rice.krad.service.PessimisticLockService pessimisticLockService) Inject PessimisticLockService singleton
void	updateDocumentDescription(BudgetVersionOverview budgetVersion)
protected void	updateProjectIncomes(BudgetDocument budgetDocument, List<BudgetProjectIncome> projectIncomes) This method is to handle budgetprojectincomes independently.
boolean	validateBudgetAuditRule(BudgetParentDocument<T> parentDocument) This method to invoke audit rule check for budget if status is final only This is called by PD's turnon validation
boolean	validateBudgetAuditRuleBeforeSaveBudgetVersion(BudgetParentDocument<T> proposalDevelopmentDocument) This method to check the audit rule when try to save 'budgetversion' and with 'complete' status.
boolean	ValidInflationCeRate(BudgetLineItemBase budgetLineItem) check if this line item CE has inflation rate This method...

Methods inherited from class java.lang.Object

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

Constructor Detail

BudgetServiceImpl

public BudgetServiceImpl()

Method Detail

addBudgetVersion

public BudgetDocument<T> addBudgetVersion(BudgetParentDocument<T> document,
                                 String versionName)
                                                        throws org.kuali.rice.kew.api.exception.WorkflowException

Service method for adding a BudgetVersionOverview to a ProposalDevelopmentDocument. If a BudgetVersionOverview instance with the versionName already exists in the ProposalDevelopmentDocument, then a hard error will occur. Try it and you'll see what I mean.

Specified by:

addBudgetVersion in interface BudgetService<T extends BudgetParent>

Parameters:

document - instance to add BudgetVersionOverview to

versionName - of the BudgetVersionOverview

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

getNewBudgetVersion

protected BudgetDocument<T> getNewBudgetVersion(BudgetParentDocument<T> parentDocument,
                                    String versionName)
                                                              throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

isBudgetVersionNameValid

public boolean isBudgetVersionNameValid(BudgetParentDocument<T> document,
                               String name)

Runs business rules on the given name of a BudgetVersionOverview instance and ProposalDevelopmentDocument instance to determine if it is ok to add a BudgetVersionOverview instance to a BudgetDocument instance. If the business rules fail, this should be false and there will be errors in the error map.

Takes care of all the setup and calling of the KualiRuleService. Uses the AddBudgetVersionEvent.

Specified by:

isBudgetVersionNameValid in interface BudgetService<T extends BudgetParent>

Parameters:

document - ProposalDevelopmentDocument to validate against

name - of the pseudo-BudgetVersionOverview instance to validate

Returns:

true for valid false otherwie

getPessimisticLockService

public org.kuali.rice.krad.service.PessimisticLockService getPessimisticLockService()

Retrieve injected PessimisticLockService singleton

Returns:

PessimisticLockService

setPessimisticLockService

public void setPessimisticLockService(org.kuali.rice.krad.service.PessimisticLockService pessimisticLockService)

Inject PessimisticLockService singleton

Parameters:

pessimisticLockService - to assign

getBudgetVersionRule

public BudgetVersionRule getBudgetVersionRule()

Retrieve injected AddBudgetVersionRule singleton

Returns:

AddBudgetVersionRule

setBudgetVersionRule

public void setBudgetVersionRule(BudgetVersionRule budgetVersionRule)

Inject AddBudgetVersionRule singleton

saveBudgetDocument

protected void saveBudgetDocument(BudgetDocument<T> budgetDocument)
                           throws org.kuali.rice.kew.api.exception.WorkflowException

This method...

Parameters:

budgetDocument -

isProposalBudget -

budget -

budgetParent -

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

updateDocumentDescription

public void updateDocumentDescription(BudgetVersionOverview budgetVersion)

Specified by:

updateDocumentDescription in interface BudgetService<T extends BudgetParent>

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

Sets the ParameterService.

Parameters:

parameterService - the parameter service.

setBudgetPersonService

public void setBudgetPersonService(BudgetPersonService budgetPersonService)

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

fixProperty

protected void fixProperty(Object object,
               String methodName,
               Class clazz,
               Object propertyValue,
               Map<String,Object> objectMap)

Recurse through all of the BOs and if a BO has a ProposalNumber property, set its value to the new proposal number.

Parameters:

object - the object

proposalNumber - the proposal number

isPropertyGetterMethod

protected boolean isPropertyGetterMethod(Method method,
                             Method[] methods)

Is the given method a getter method for a property? Must conform to the following:

1. Must start with the get
2. Must have a corresponding setter method
3. Must have zero arguments.

Parameters:

method - the method to check

methods - the other methods in the object

Returns:

true if it is property getter method; otherwise false

getSavedBudgetRates

public Collection<BudgetRate> getSavedBudgetRates(Budget budget)

Description copied from interface: BudgetService

This method returns the saved Proposal Rates collection.

Specified by:

getSavedBudgetRates in interface BudgetService<T extends BudgetParent>

Returns:

Collection

checkActivityTypeChange

public boolean checkActivityTypeChange(Collection<BudgetRate> allPropRates,
                              String activityTypeCode)

Description copied from interface: BudgetService

This method checks if activity type changed, then display confirmation message on 'open' budget version.

Specified by:

checkActivityTypeChange in interface BudgetService<T extends BudgetParent>

Returns:

checkActivityTypeChange

public boolean checkActivityTypeChange(BudgetParentDocument<T> budgetParentDoc,
                              Budget budget)

Description copied from interface: BudgetService

This method check if activity type changed, then display confirmation message on 'open' budget version.

Specified by:

checkActivityTypeChange in interface BudgetService<T extends BudgetParent>

Returns:

ValidInflationCeRate

public boolean ValidInflationCeRate(BudgetLineItemBase budgetLineItem)

Description copied from interface: BudgetService

check if this line item CE has inflation rate This method...

Specified by:

ValidInflationCeRate in interface BudgetService<T extends BudgetParent>

Returns:

getActivityTypeForBudget

public String getActivityTypeForBudget(BudgetDocument<T> budgetDocument)

Specified by:

getActivityTypeForBudget in interface BudgetService<T extends BudgetParent>

getApplicableCostElements

public List<ValidCeJobCode> getApplicableCostElements(Long budgetId,
                                             String personSequenceNumber)

Description copied from interface: BudgetService

This method returns the applicable Object Codes (Cost Elements) for a given Budget Person based on his Job Code

Specified by:

getApplicableCostElements in interface BudgetService<T extends BudgetParent>

Returns:

List of Cost Elements

getApplicableCostElementsForAjaxCall

public String getApplicableCostElementsForAjaxCall(Long budgetId,
                                          String personSequenceNumber,
                                          String budgetCategoryTypeCode)

Description copied from interface: BudgetService

This method returns the applicable Object Codes (Cost Elements) for a given Budget Person, converted to string separated by ",".

Specified by:

getApplicableCostElementsForAjaxCall in interface BudgetService<T extends BudgetParent>

Returns:

List of Cost Elements

getExistingGroupNames

public List<String> getExistingGroupNames(String budgetId,
                                 String budgetPeriod)

Description copied from interface: BudgetService

This method returns the existing Personnel Line Item Group Names based on his Job Code

Specified by:

getExistingGroupNames in interface BudgetService<T extends BudgetParent>

Returns:

List of existing Group Names

getExistingGroupNamesForAjaxCall

public String getExistingGroupNamesForAjaxCall(String budgetId,
                                      String budgetPeriod)

Description copied from interface: BudgetService

This method returns the existing Personnel Line Item Group Names , converted to string separated by ",".

Specified by:

getExistingGroupNamesForAjaxCall in interface BudgetService<T extends BudgetParent>

Returns:

List of existing Group Names

getBudgetExpensePanelName

public String getBudgetExpensePanelName(BudgetPeriod budgetPeriod,
                               BudgetLineItem budgetLineItem)

Description copied from interface: BudgetService

This method returns the Non-Personnel Panel Name (based on the variables).

Specified by:

getBudgetExpensePanelName in interface BudgetService<T extends BudgetParent>

Returns:

Non-Personnel Panel Name for the passed in Line Item

getParticipantSupportCategoryCode

public String getParticipantSupportCategoryCode()

Specified by:

getParticipantSupportCategoryCode in interface BudgetService<T extends BudgetParent>

getMatchingLineItems

public List<BudgetLineItem> getMatchingLineItems(List<BudgetLineItem> lineItems,
                                        List<String> budgetCategoryType)

Specified by:

getMatchingLineItems in interface BudgetService<T extends BudgetParent>

getSavedProposalRates

public Collection<BudgetRate> getSavedProposalRates(BudgetVersionOverview budgetToOpen)

Specified by:

getSavedProposalRates in interface BudgetService<T extends BudgetParent>

validateBudgetAuditRule

public boolean validateBudgetAuditRule(BudgetParentDocument<T> parentDocument)
                                throws Exception

Description copied from interface: BudgetService

This method to invoke audit rule check for budget if status is final only This is called by PD's turnon validation

Specified by:

validateBudgetAuditRule in interface BudgetService<T extends BudgetParent>

Returns:

Throws:

Exception

See Also:

org.kuali.kra.proposaldevelopment.service.ProposalDevelopmentService#validateBudgetAuditRule(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument)

validateBudgetAuditRuleBeforeSaveBudgetVersion

public boolean validateBudgetAuditRuleBeforeSaveBudgetVersion(BudgetParentDocument<T> proposalDevelopmentDocument)
                                                       throws Exception

Description copied from interface: BudgetService

This method to check the audit rule when try to save 'budgetversion' and with 'complete' status.

Specified by:

validateBudgetAuditRuleBeforeSaveBudgetVersion in interface BudgetService<T extends BudgetParent>

Returns:

Throws:

Exception

See Also:

org.kuali.kra.proposaldevelopment.service.ProposalDevelopmentService#validateBudgetAuditRuleBeforeSaveBudgetVersion(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument)

applyAuditRuleForBudgetDocument

protected boolean applyAuditRuleForBudgetDocument(BudgetVersionOverview budgetVersion)
                                           throws Exception

Throws:

Exception

copyBudgetVersion

public BudgetDocument copyBudgetVersion(BudgetDocument budgetDocument,
                               boolean onlyOnePeriod)
                                 throws org.kuali.rice.kew.api.exception.WorkflowException

Description copied from interface: BudgetService

Returns a new finalized BudgetDocument with the data from the given BudgetDocument copied over.

Specified by:

copyBudgetVersion in interface BudgetService<T extends BudgetParent>

Returns:

BudgetDocument

Throws:

NoSuchMethodException

InvocationTargetException

IllegalAccessException

org.kuali.rice.core.web.format.FormatException

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

org.kuali.kra.budget.core.BudgetService#copyBudgetVersion(org.kuali.kra.budget.document.BudgetDocument)

getBudgetCommonService

protected BudgetCommonService<BudgetParent> getBudgetCommonService(BudgetParentDocument parentBudgetDocument)

updateProjectIncomes

protected void updateProjectIncomes(BudgetDocument budgetDocument,
                        List<BudgetProjectIncome> projectIncomes)

This method is to handle budgetprojectincomes independently. budgetprojectincomes is a collection of 'budget', but it also reference to budgetperiod. During copy budgetperiodid is set to null. If save with budgetdocument, then budgetperiodid will not be set. So, has to use this to set manually.

Parameters:

budgetDocument -

projectIncomes -

copyLineItemToPersonnelDetails

protected void copyLineItemToPersonnelDetails(BudgetDocument budgetDocument)

Do this so that new personnel details(or copied ones) can be calculated

Parameters:

budgetDocument -

getBudgetRatesService

public BudgetRatesService<T> getBudgetRatesService()

Gets the budgetRatesService attribute.

Returns:

Returns the budgetRatesService.

setBudgetRatesService

public void setBudgetRatesService(BudgetRatesService<T> budgetRatesService)

Sets the budgetRatesService attribute value.

Parameters:

budgetRatesService - The budgetRatesService to set.

setDeepCopyPostProcessor

public void setDeepCopyPostProcessor(DeepCopyPostProcessor deepCopyPostProcessor)

Sets the deepCopyPostProcessor attribute value.

Parameters:

deepCopyPostProcessor - The deepCopyPostProcessor to set.

getDeepCopyPostProcessor

public DeepCopyPostProcessor getDeepCopyPostProcessor()

Gets the deepCopyPostProcessor attribute.

Returns:

Returns the deepCopyPostProcessor.

getBudgetSummaryService

public BudgetSummaryService getBudgetSummaryService()

Gets the budgetSummaryService attribute.

Returns:

Returns the budgetSummaryService.

setBudgetSummaryService

public void setBudgetSummaryService(BudgetSummaryService budgetSummaryService)

Sets the budgetSummaryService attribute value.

Parameters:

budgetSummaryService - The budgetSummaryService to set.

getFiscalYearMonthService

public FiscalYearMonthService getFiscalYearMonthService()

setFiscalYearMonthService

public void setFiscalYearMonthService(FiscalYearMonthService fiscalYearMonthService)

getBaseSalaryByPeriod

public BudgetDecimal getBaseSalaryByPeriod(Long budgetId,
                                  int budgetPeriod,
                                  KeyPersonInfo person)

Specified by:

getBaseSalaryByPeriod in interface BudgetService<T extends BudgetParent>

populateBudgetPersonSalaryDetailsInPeriods

public String populateBudgetPersonSalaryDetailsInPeriods(String budgetId,
                                                String personSequenceNumber,
                                                String personId)

Specified by:

populateBudgetPersonSalaryDetailsInPeriods in interface BudgetService<T extends BudgetParent>

populateNewBudgetLineItem

public void populateNewBudgetLineItem(BudgetLineItem newBudgetLineItem,
                             BudgetPeriod budgetPeriod)

Specified by:

populateNewBudgetLineItem in interface BudgetService<T extends BudgetParent>

isBudgetFormulatedCostEnabled

protected boolean isBudgetFormulatedCostEnabled()

getFormulatedCostElements

protected List<String> getFormulatedCostElements()

getDocumentService

protected org.kuali.rice.krad.service.DocumentService getDocumentService()

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

getBudgetPersonService

protected BudgetPersonService getBudgetPersonService()