org.kuali.kra.external.budget.impl

Class BudgetAdjustmentClientBase

java.lang.Object

org.kuali.kra.external.budget.impl.BudgetAdjustmentClientBase

All Implemented Interfaces:

BudgetAdjustmentClient

Direct Known Subclasses:

BudgetAdjustmentClientImpl, BudgetAdjustmentKSBClientImpl

public abstract class BudgetAdjustmentClientBase
extends Object
implements BudgetAdjustmentClient

This is the base class for the client that connects to the Budget Adjustment Service on the financial system.

Field Summary

Fields

Modifier and Type	Field and Description
protected static QName	SERVICE_NAME
protected static String	SOAP_SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
BudgetAdjustmentClientBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	createAccountingLines(Map<String,BudgetDecimal> accountingLines, AwardBudgetDocument awardBudgetDocument, BudgetAdjustmentParametersDTO parametersDTO) This method creates the accounting lines for the BA.
void	createBudgetAdjustmentDocument(AwardBudgetDocument awardBudgetDocument)
protected boolean	createBudgetAdjustmentDocumentHeader(AwardBudgetDocument awardBudgetDocument, BudgetAdjustmentParametersDTO parametersDTO) This method sets the budget adjustment document header.
protected String	getAwardAccount(AwardBudgetDocument awardBudgetDocument) This method returns the award account number.
protected String	getAwardChart(AwardBudgetDocument awardBudgetDocument) This method returns the chart of accounts code associated with the account.
protected BudgetAdjustmentServiceHelper	getBudgetAdjustmentServiceHelper()
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected String[]	getElements(String person) This method splits the string into object code and person id.
protected String	getFinancialObjectCode(AwardBudgetDocument awardBudgetDocument, String rateClassCode, String rateTypeCode) This is obtained using the mapping table.
protected String	getFinancialObjectCode(String costElementName) This is obtained from the cost element table.
protected List<FinancialObjectCodeMapping>	getFinancialObjectCodesFromMappingTable(String rateClassCode, String rateTypeCode, String unitNumber) This method gets the KFs object code from the mapping table.
protected AwardBudgetExt	getNewestBudgetByStatus(AwardDocument awardDocument, List<String> statuses) This method returns the newest budget by status
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
protected String	getParameterValue(String awardBudgetParameter)
protected String	getParameterValue(String parameterName, String key) This method gets the parameter list which is in the form key=financialSystemCode, checks if the kcCode is found and returns the corresponding financial code.
protected String	getPostedBudgetStatus()
protected AwardBudgetExt	getPrevBudget(AwardBudgetDocument awardBudgetDocument) This method returns the previous version of the award budget.
protected AwardBudgetExt	getPrevBudget(AwardDocument awardDocument) This method returns previous budget
protected String	getProjectCode()
protected abstract BudgetAdjustmentService	getServiceHandle() This method gets either the SOAP handle or the KSB handle depending on the configuration.
boolean	setBudgetAdjustmentParameters(AwardBudgetDocument awardBudgetDocument, BudgetAdjustmentParametersDTO parametersDTO) This method adds the accounting lines to the DTO
void	setBudgetAdjustmentServiceHelper(BudgetAdjustmentServiceHelper budgetAdjustmentServiceHelper)
void	setBudgetCalculationService(BudgetCalculationService budgetCalculationService)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService) Sets the documentService attribute value.
protected boolean	setIndirectCostAccountingLine(AwardBudgetDocument awardBudgetDocument, Map<String,BudgetDecimal> accountingLines) This method sets the indirect cost.
void	setInstitutionalUnitService(InstitutionalUnitService institutionalUnitService)
protected boolean	setNonPersonnelAccountingLines(AwardBudgetDocument awardBudgetDocument, Map<String,BudgetDecimal> accountingLines) This method sets the no personnel accounting line.
protected boolean	setNonPersonnelCalculatedDirectCostAccountingLines(AwardBudgetDocument awardBudgetDocument, Map<String,BudgetDecimal> accountingLines) This method sets the non personnel calculated direct cost.
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
protected boolean	setPersonnelFringeAccountingLines(AwardBudgetDocument awardBudgetDocument, Map<String,BudgetDecimal> accountingLines) This method sets the fringe line.
protected boolean	setPersonnelSalaryAccountingLines(AwardBudgetDocument awardBudgetDocument, Map<String,BudgetDecimal> accountingLines) This method sets the personnel salary accounting line.
protected boolean	setPersonnnelCalculatedDirectCost(AwardBudgetDocument awardBudgetDocument, Map<String,BudgetDecimal> accountingLines) Sets PersonnelCalculatedDirect cost

Methods inherited from class java.lang.Object

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

Field Detail

SOAP_SERVICE_NAME

protected static final String SOAP_SERVICE_NAME

See Also:

Constant Field Values

SERVICE_NAME

protected static final QName SERVICE_NAME

Constructor Detail

BudgetAdjustmentClientBase

public BudgetAdjustmentClientBase()

Method Detail

getServiceHandle

protected abstract BudgetAdjustmentService getServiceHandle()

This method gets either the SOAP handle or the KSB handle depending on the configuration.

Returns:

createBudgetAdjustmentDocument

public void createBudgetAdjustmentDocument(AwardBudgetDocument awardBudgetDocument)
                                    throws Exception

Specified by:

createBudgetAdjustmentDocument in interface BudgetAdjustmentClient

Throws:

Exception

See Also:

org.kuali.kra.external.budget.BudgetAdjustmentClient#createBudgetAdjustmentDocument()

setBudgetAdjustmentParameters

public boolean setBudgetAdjustmentParameters(AwardBudgetDocument awardBudgetDocument,
                                    BudgetAdjustmentParametersDTO parametersDTO)
                                      throws Exception

This method adds the accounting lines to the DTO

Parameters:

parametersDTO -

Returns:

Throws:

Exception

setPersonnnelCalculatedDirectCost

protected boolean setPersonnnelCalculatedDirectCost(AwardBudgetDocument awardBudgetDocument,
                                        Map<String,BudgetDecimal> accountingLines)

Sets PersonnelCalculatedDirect cost

Parameters:

accountingLines -

Returns:

setIndirectCostAccountingLine

protected boolean setIndirectCostAccountingLine(AwardBudgetDocument awardBudgetDocument,
                                    Map<String,BudgetDecimal> accountingLines)

This method sets the indirect cost.

Parameters:

accountingLines -

Returns:

setPersonnelFringeAccountingLines

protected boolean setPersonnelFringeAccountingLines(AwardBudgetDocument awardBudgetDocument,
                                        Map<String,BudgetDecimal> accountingLines)

This method sets the fringe line.

Parameters:

accountingLines -

Returns:

setPersonnelSalaryAccountingLines

protected boolean setPersonnelSalaryAccountingLines(AwardBudgetDocument awardBudgetDocument,
                                        Map<String,BudgetDecimal> accountingLines)
                                             throws Exception

This method sets the personnel salary accounting line.

Parameters:

accountingLines -

Returns:

Throws:

Exception

getElements

protected String[] getElements(String person)
                        throws Exception

This method splits the string into object code and person id.

Parameters:

person -

Returns:

Throws:

Exception

setNonPersonnelCalculatedDirectCostAccountingLines

protected boolean setNonPersonnelCalculatedDirectCostAccountingLines(AwardBudgetDocument awardBudgetDocument,
                                                         Map<String,BudgetDecimal> accountingLines)

This method sets the non personnel calculated direct cost.

Parameters:

accountingLines -

Returns:

setNonPersonnelAccountingLines

protected boolean setNonPersonnelAccountingLines(AwardBudgetDocument awardBudgetDocument,
                                     Map<String,BudgetDecimal> accountingLines)

This method sets the no personnel accounting line.

Parameters:

accountingLines -

Returns:

getPrevBudget

protected AwardBudgetExt getPrevBudget(AwardBudgetDocument awardBudgetDocument)

This method returns the previous version of the award budget.

Returns:

getParameterValue

protected String getParameterValue(String awardBudgetParameter)

getPostedBudgetStatus

protected String getPostedBudgetStatus()

getPrevBudget

protected AwardBudgetExt getPrevBudget(AwardDocument awardDocument)

This method returns previous budget

Parameters:

awardDocument -

Returns:

getNewestBudgetByStatus

protected AwardBudgetExt getNewestBudgetByStatus(AwardDocument awardDocument,
                                     List<String> statuses)

This method returns the newest budget by status

Parameters:

awardDocument -

statuses -

Returns:

createBudgetAdjustmentDocumentHeader

protected boolean createBudgetAdjustmentDocumentHeader(AwardBudgetDocument awardBudgetDocument,
                                           BudgetAdjustmentParametersDTO parametersDTO)

This method sets the budget adjustment document header.

Returns:

createAccountingLines

protected void createAccountingLines(Map<String,BudgetDecimal> accountingLines,
                         AwardBudgetDocument awardBudgetDocument,
                         BudgetAdjustmentParametersDTO parametersDTO)

This method creates the accounting lines for the BA.

getParameterValue

protected String getParameterValue(String parameterName,
                       String key)

This method gets the parameter list which is in the form key=financialSystemCode, checks if the kcCode is found and returns the corresponding financial code.

Parameters:

parameterName -

kcCode -

Returns:

getAwardChart

protected String getAwardChart(AwardBudgetDocument awardBudgetDocument)

This method returns the chart of accounts code associated with the account.

Parameters:

awardBudgetDocument -

Returns:

getProjectCode

protected String getProjectCode()

getFinancialObjectCode

protected String getFinancialObjectCode(AwardBudgetDocument awardBudgetDocument,
                            String rateClassCode,
                            String rateTypeCode)

This is obtained using the mapping table.

Parameters:

rateClassCode -

rateTypeCode -

Returns:

getFinancialObjectCode

protected String getFinancialObjectCode(String costElementName)

This is obtained from the cost element table.

Parameters:

costElementName -

Returns:

getFinancialObjectCodesFromMappingTable

protected List<FinancialObjectCodeMapping> getFinancialObjectCodesFromMappingTable(String rateClassCode,
                                                                       String rateTypeCode,
                                                                       String unitNumber)

This method gets the KFs object code from the mapping table.

Parameters:

rateClassCode -

rateTypeCode -

unitNumber -

Returns:

getAwardAccount

protected String getAwardAccount(AwardBudgetDocument awardBudgetDocument)

This method returns the award account number.

Parameters:

awardBudgetDocument -

Returns:

getBudgetAdjustmentServiceHelper

protected BudgetAdjustmentServiceHelper getBudgetAdjustmentServiceHelper()

setBudgetAdjustmentServiceHelper

public void setBudgetAdjustmentServiceHelper(BudgetAdjustmentServiceHelper budgetAdjustmentServiceHelper)

Specified by:

setBudgetAdjustmentServiceHelper in interface BudgetAdjustmentClient

setInstitutionalUnitService

public void setInstitutionalUnitService(InstitutionalUnitService institutionalUnitService)

Specified by:

setInstitutionalUnitService in interface BudgetAdjustmentClient

getBusinessObjectService

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

setBusinessObjectService

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

Specified by:

setBusinessObjectService in interface BudgetAdjustmentClient

setBudgetCalculationService

public void setBudgetCalculationService(BudgetCalculationService budgetCalculationService)

Specified by:

setBudgetCalculationService in interface BudgetAdjustmentClient

getParameterService

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

setParameterService

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

Specified by:

setParameterService in interface BudgetAdjustmentClient

setDocumentService

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

Sets the documentService attribute value. Injected by Spring.

Specified by:

setDocumentService in interface BudgetAdjustmentClient

Parameters:

documentService - The documentService to set.