org.kuali.kra.budget.printing.xmlstream

Class BudgetBaseSalaryStream

java.lang.Object

org.kuali.kra.budget.printing.xmlstream.BudgetBaseStream

org.kuali.kra.budget.printing.xmlstream.BudgetBaseSalaryStream

All Implemented Interfaces:

XmlStream

Direct Known Subclasses:

BudgetSalaryXmlStream, BudgetSummaryTotalXmlStream, BudgetTotalXmlStream, IndustrialCumBudgetXmlStream

public abstract class BudgetBaseSalaryStream
extends BudgetBaseStream

This class will contain all common methods that can be used across budget salary ,budget total ,budget summary total , and industrial cumulative budget XML generator streams . All those report XML stream implementations need to extend and use the functions defined in this class.

Author:

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CALCULATED_AMOUNT_COST_ELEMENT_DESC
protected static String	EMPTY_STRING
protected static String	OVERHEAD_RATE_PREFIX
protected static String	PERIOD_COST_TOTAL
protected static String	SEPARATER_STRING

Fields inherited from class org.kuali.kra.budget.printing.xmlstream.BudgetBaseStream

ALLOCATED_ADMIN_SUPPORT, ALLOCATED_ADMINISTRATIVE_SUPPORT, ALLOCATED_LAB_EXPENSE, budget, BUDGET_CATEGORY_PERSONNEL, BUDGET_PERIOD, budgetPeriod, budgetPersRateAndBaseList, budgetPersRateAndBases, businessObjectService, category, CATEGORY_CODE_LA_SALARY, DATE_FORMAT, DATE_FORMAT_MMDDYY, dateTimeService, DEFAULT_RATE_TYPE_CODE_FOR_LI, EMPLOYEE_BENEFITS_ON_ALLOCATED_ADMINISTRATIVE_SUPPORT, LAB_ALLOCATION, OTHER_DIRECT_COSTS, PERCENTAGE, PRINCIPAL_INVESTIGATOR_ROLE, RATE_CLASS_CODE_EB_ON_LA, RATE_CLASS_CODE_LA_SALARY, RATE_CLASS_CODE_VACATION_ON_LA, RATE_TYPE_CODE_LA_SALARY, RATE_TYPE_CODE_VACATION_ON_LA, rateClass, rateClassRateType, rateType, TOTAL_EMPLOYEE_BENEFITS

Constructor Summary

Constructors

Constructor and Description
BudgetBaseSalaryStream()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<BudgetDataPeriodVO>	getBudgetDataPeriodsForCalculatedAmounts(String rateClassCode, String rateTypeCode, boolean includeNonPersonnel) This method will return the budget data periods for calculated amounts.It checks rate type code ,rate class code against list of Budget LineItem Calculated Amounts for each budget line item of each budget period of budget ,if it is equals then add calculated cost of budget LineItem Calculated Amount to period cost.
protected noNamespace.BudgetSalaryDocument.BudgetSalary	getBudgetSalaryTypeXmlObject() This method will set the values to BudgetSalary Attributes and finally return the Budget Salary xml object.
protected noNamespace.SalaryType[]	getBudgetTotalAndSummarySalaryTypes(boolean includeNonPersonnel) This method will set the values to salary type attributes and finally return the array of Salary type
protected List<noNamespace.SalaryType>	getListOfSalaryTypeXmlObjects(List<SalaryTypeVO> salaryTypeVoList) This method will iterate over salaryTypeVo List and set to xml bean SalaryType and sort the List based on costElement
protected SalaryTypeVO	getSalaryTypeVOForCostElement(String costElemetDesc, String costElementCode) This method gets SalaryTypeVO for costElement.
protected noNamespace.SalaryType	getSalaryTypeXmlObject(String costElementDesc, String costElementCode, String name, noNamespace.BudgetPeriodData[] budgetPeriodArray, BudgetDecimal total) This method will set the values to Salary attributes and finally returns the salary Type Object
protected boolean	isPersonnel(String budgetCategoryType)
protected void	setSalaryTypesForLineItemCalcuAmount(List<SalaryTypeVO> salaryTypeVoList, boolean includeNonPersonnel) This method will set the values to salaryType VO for budget line calculated amount

Methods inherited from class org.kuali.kra.budget.printing.xmlstream.BudgetBaseStream

getBudgetCategoryCodeFroBudgetSalarySummary, getBudgetCategoryDescForSalarySummary, getBudgetIndirectCostsForReport, getBusinessObjectService, getCalculatedCostForBudgetExclusionsSortId1, getCalculatedCostForBudgetExclusionsSortId4, getCalculatedCostForBudgetLAExclusionsSortId2, getCalculatedCostForBudgetOHExclusionsSortId2, getCalculationMethodology, getCostElementDescription, getDateTimeService, getEmpBenefitAppliedRateForPersonnel, getFringeForBudgetSalarySummaryFromPersonnelRateAndBase, getGroupsType, getGroupsType, getInvestigatorFlag, getKeyForBudgetSalarySummary, getPercentChargedForBudgetPersonnelRateBase, getPercentEffortForBudgetPersonnelRateBase, getPersonNameFromBudgetPersonByRateAndBase, getRatesApplicableToVOList, getReportHeaderTypeForCumulativeReport, getReportTypeForBudgetIndirectCostsForReport, getReportTypeForExclusions, getReportTypeForNonPersonnel, getReportTypeListForBudgetEBRateAndBase, getReportTypeListForBudgetLARateAndBase, getReportTypeListForBudgetOHRateAndBase, getReportTypeListForBudgetOtherRateAndBase, getReportTypeListForBudgetVACRateAndBase, getReportTypeVOForBudgetLASalaryForRateBase, getReportTypeVOList, getTotalCalculatedCostByRateClassTypeFromLineItem, getTotalCostSharingAmountByRateClassTypeFromLineItem, getUnitNumber, getVacationAppliedRateForPersonnel, isBudgetCategoryPersonnel, isLineItemCalAmountOfRateClassTypeLabAllocation, isLineItemCalAmountOfRateClassTypeLAWithEBVA, isLineItemCalAmountOfRateClassTypeOverhead, isRateAndBaseEBonLA, isRateAndBaseLASalary, isRateAndBaseOfRateClassTypeEB, isRateAndBaseOfRateClassTypeLAwithEBVA, isRateAndBaseOfRateClassTypeOverhead, isRateAndBaseOfRateClassTypeVacation, isRateAndBaseVAonLA, setBudgetLASalaryForBudgetRateAndBase, setBudgetPersRateAndBaseListForBudgetEBRateAndBase, setBudgetPersRateAndBaseListForBudgetLARateAndBase, setBudgetPersRateAndBaseListForBudgetOHRateAndBase, setBudgetPersRateAndBaseListForBudgetOtherRateAndBase, setBudgetPersRateAndBaseListForBudgetVacRateAndBase, setBudgetRateAndBaseListForBudgetEBRateAndBase, setBudgetRateAndBaseListForBudgetLARateAndBase, setBudgetRateAndBaseListForBudgetOHRateAndBase, setBudgetRateAndBaseListForBudgetOtherRateAndBase, setBudgetRateAndBaseListForBudgetVacRateAndBase, setBusinessObjectService, setDateTimeService, setReportTypeBudgetLASalary, setReportTypeForBudgetLAExclusionsSortId3, setReportTypeList, setReportTypeListOHExclusionForSortId, setReportTypeMapForBudgetOHRateAndBase, setReportTypeMapFromReportTypeVOList, setReportTypeOHExclusionForSortId, setReportTypeVOListForLAExclusionSortId3, setReportTypeVOListForOHExclusionSortId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.kra.printing.xmlstream.XmlStream

generateXmlStream

Field Detail

SEPARATER_STRING

protected static final String SEPARATER_STRING

See Also:

Constant Field Values

OVERHEAD_RATE_PREFIX

protected static final String OVERHEAD_RATE_PREFIX

See Also:

Constant Field Values

EMPTY_STRING

protected static final String EMPTY_STRING

See Also:

Constant Field Values

PERIOD_COST_TOTAL

protected static final String PERIOD_COST_TOTAL

See Also:

Constant Field Values

CALCULATED_AMOUNT_COST_ELEMENT_DESC

protected static final String CALCULATED_AMOUNT_COST_ELEMENT_DESC

See Also:

Constant Field Values

Constructor Detail

BudgetBaseSalaryStream

public BudgetBaseSalaryStream()

Method Detail

getBudgetSalaryTypeXmlObject

protected noNamespace.BudgetSalaryDocument.BudgetSalary getBudgetSalaryTypeXmlObject()

This method will set the values to BudgetSalary Attributes and finally return the Budget Salary xml object.

Returns:

Budget Salary xml object

getSalaryTypeXmlObject

protected noNamespace.SalaryType getSalaryTypeXmlObject(String costElementDesc,
                                            String costElementCode,
                                            String name,
                                            noNamespace.BudgetPeriodData[] budgetPeriodArray,
                                            BudgetDecimal total)

This method will set the values to Salary attributes and finally returns the salary Type Object

Parameters:

costElementDesc - is a cost element description

costElementCode - is a cost element code

name - is a cost element description

budgetPeriodArray - is array of budget periods xml objects

total - is a sum of period costs for budget period

Returns:

Salary Type xml object

getBudgetTotalAndSummarySalaryTypes

protected noNamespace.SalaryType[] getBudgetTotalAndSummarySalaryTypes(boolean includeNonPersonnel)

This method will set the values to salary type attributes and finally return the array of Salary type

Returns:

Salary type array

getSalaryTypeVOForCostElement

protected SalaryTypeVO getSalaryTypeVOForCostElement(String costElemetDesc,
                                         String costElementCode)

This method gets SalaryTypeVO for costElement. For given cost element description get's list of budget period data's and finally set to SalaryTypeVO;

Parameters:

costElemetDesc -

costElementCode -

Returns:

SalaryTypeVO

setSalaryTypesForLineItemCalcuAmount

protected void setSalaryTypesForLineItemCalcuAmount(List<SalaryTypeVO> salaryTypeVoList,
                                        boolean includeNonPersonnel)

This method will set the values to salaryType VO for budget line calculated amount

Parameters:

salaryTypeVoList - is a list contains set of salary types based on budget line calculated amount

isPersonnel

protected boolean isPersonnel(String budgetCategoryType)

getBudgetDataPeriodsForCalculatedAmounts

protected List<BudgetDataPeriodVO> getBudgetDataPeriodsForCalculatedAmounts(String rateClassCode,
                                                                String rateTypeCode,
                                                                boolean includeNonPersonnel)

This method will return the budget data periods for calculated amounts.It checks rate type code ,rate class code against list of Budget LineItem Calculated Amounts for each budget line item of each budget period of budget ,if it is equals then add calculated cost of budget LineItem Calculated Amount to period cost.

Parameters:

rateClassCode -

rateTypeCode -

Returns:

list of BudgetDataPeriod VO's

getListOfSalaryTypeXmlObjects

protected List<noNamespace.SalaryType> getListOfSalaryTypeXmlObjects(List<SalaryTypeVO> salaryTypeVoList)

This method will iterate over salaryTypeVo List and set to xml bean SalaryType and sort the List based on costElement

Parameters:

salaryTypeVoList -

Returns:

list of SalaryType xml bean