org.kuali.kfs.module.tem.service

Interface PerDiemService

All Known Implementing Classes:

PerDiemServiceImpl

public interface PerDiemService

define the common method calls around Per Diem objects

Method Summary

Methods

Modifier and Type	Method and Description
<T extends PerDiem> void	breakDownMealsIncidental(List<T> perDiemList) break down meals and incidental if needed
<T extends PerDiem> void	breakDownMealsIncidental(T perDiem) break down meals and incidental if needed
org.kuali.rice.core.api.util.type.KualiDecimal	getDailyTotalGrandTotal(TravelDocument travelDocument)
String	getDefaultPerDiemMileageRateExpenseType() Looks up, from the parameter KFS-TEM / Document / PER_DIEM_MILEAGE_RATE_EXPENSE_TYPE_CODE what the default per diem mileage expense type is
org.kuali.rice.core.api.util.type.KualiDecimal	getLodgingGrandTotal(TravelDocument travelDocument)
org.kuali.rice.core.api.util.type.KualiDecimal	getMealsAndIncidentalsGrandTotal(TravelDocument travelDocument)
org.kuali.rice.core.api.util.type.KualiDecimal	getMileageTotalGrandTotal(TravelDocument travelDocument)
Integer	getMilesGrandTotal(TravelDocument travelDocument)
PerDiem	getPerDiem(int primaryDestinationId, Timestamp perDiemDate, Date effectiveDate) Finds the active per diem record for the given destination id and date
<T extends PerDiem> boolean	hasExistingPerDiem(T perDiem) check whether the given per diem exists in the database
boolean	isMileageRateAvailableForAllPerDiem(TravelDocument doc) Determines if: A current mileage rate for the KFS-TEM / Document / PER_DIEM_MILEAGE_RATE_EXPENSE_TYPE_CODE is available; if it is not, then per diem cannot be created
boolean	isPerDiemHandlingLodging()
<T extends PerDiem> List<PerDiem>	retrievePreviousPerDiem(T perDiem) find the previous per diem for the given new per diem
void	setPerDiemCategoriesAndBreakdown(TravelFormBase form) Set the PerDiem Categories display on a TravelForm and whether or not display detail breakdown on meals For TA and TR docs
<T extends PerDiem> void	updateTripType(List<T> perDiemList) update the trip type of the given per diem
<T extends PerDiem> void	updateTripType(T perDiem) update the trip type of the given per diem

Method Detail

breakDownMealsIncidental

<T extends PerDiem> void breakDownMealsIncidental(List<T> perDiemList)

break down meals and incidental if needed

Parameters:

perDiemList - the given list of per diem records

breakDownMealsIncidental

<T extends PerDiem> void breakDownMealsIncidental(T perDiem)

break down meals and incidental if needed

Parameters:

perDiem - the given per diem

updateTripType

<T extends PerDiem> void updateTripType(List<T> perDiemList)

update the trip type of the given per diem

Parameters:

perDiemList - the given list of per diem records

updateTripType

<T extends PerDiem> void updateTripType(T perDiem)

update the trip type of the given per diem

Parameters:

perDiem - the given per diem

retrievePreviousPerDiem

<T extends PerDiem> List<PerDiem> retrievePreviousPerDiem(T perDiem)

find the previous per diem for the given new per diem

Parameters:

perDiem - the given new per diem

Returns:

the previous per diem of the given new per diem

hasExistingPerDiem

<T extends PerDiem> boolean hasExistingPerDiem(T perDiem)

check whether the given per diem exists in the database

Parameters:

perDiem - the given per diem

Returns:

true if the given per diem exists in the database

setPerDiemCategoriesAndBreakdown

void setPerDiemCategoriesAndBreakdown(TravelFormBase form)

Set the PerDiem Categories display on a TravelForm and whether or not display detail breakdown on meals For TA and TR docs

Parameters:

form -

getMealsAndIncidentalsGrandTotal

org.kuali.rice.core.api.util.type.KualiDecimal getMealsAndIncidentalsGrandTotal(TravelDocument travelDocument)

getLodgingGrandTotal

org.kuali.rice.core.api.util.type.KualiDecimal getLodgingGrandTotal(TravelDocument travelDocument)

getMileageTotalGrandTotal

org.kuali.rice.core.api.util.type.KualiDecimal getMileageTotalGrandTotal(TravelDocument travelDocument)

getDailyTotalGrandTotal

org.kuali.rice.core.api.util.type.KualiDecimal getDailyTotalGrandTotal(TravelDocument travelDocument)

getMilesGrandTotal

Integer getMilesGrandTotal(TravelDocument travelDocument)

isPerDiemHandlingLodging

boolean isPerDiemHandlingLodging()

Returns:

true if the KFS-TEM / Document / PER_DIEM_CATEGORIES says that per diem is handling lodging; false otherwise

getPerDiem

PerDiem getPerDiem(int primaryDestinationId,
                 Timestamp perDiemDate,
                 Date effectiveDate)

Finds the active per diem record for the given destination id and date

Parameters:

primaryDestinationId - the id of the destination to find the per diem for

perDiemDate - the date we want the per diem to be active on

effectiveDate - the date to use when testing the per diem's effective date records

Returns:

the retrieved per diem or null if a record was not found

isMileageRateAvailableForAllPerDiem

boolean isMileageRateAvailableForAllPerDiem(TravelDocument doc)

Determines if:

• A current mileage rate for the KFS-TEM / Document / PER_DIEM_MILEAGE_RATE_EXPENSE_TYPE_CODE is available; if it is not, then per diem cannot be created

Parameters:

form - the form with the document on it, which may help in making such a decision

getDefaultPerDiemMileageRateExpenseType

String getDefaultPerDiemMileageRateExpenseType()

Looks up, from the parameter KFS-TEM / Document / PER_DIEM_MILEAGE_RATE_EXPENSE_TYPE_CODE what the default per diem mileage expense type is

Returns:

the default mileage rate expense type code to use on per diem