org.kuali.kpme.tklm.api.leave.summary
Interface LeaveSummaryRowContract

All Known Implementing Classes:

LeaveSummaryRow

public interface LeaveSummaryRowContract

LeaveSummaryRowContract interface

Method Summary

String	getAccrualCategory() The AccrualCategory name associated with the LeaveSummaryRow
String	getAccrualCategoryId() The AccrualCategory id associated with the LeaveSummaryRow
String	getAccrualCategoryRuleId() The AccrualCategoryRule id associated with the LeaveSummaryRow
BigDecimal	getAccruedBalance() The accrued balance associated with the LeaveSummaryRow
BigDecimal	getCarryOver() TODO: Make sure this comment is right The amount user can carry over to next year associated with the LeaveSummaryRow
BigDecimal	getFmlaUsage() The fmla usage associated with the LeaveSummaryRow
String	getInfractingLeaveBlockId() TODO: Put a better comment The infractingLeaveBlockId associated with the LeaveSummaryRow
BigDecimal	getLeaveBalance() The leave balance associated with the LeaveSummaryRow
BigDecimal	getMaxCarryOver() The max carry over associated with the LeaveSummaryRow
BigDecimal	getPendingAvailableUsage() The pending available usage associated with the LeaveSummaryRow
BigDecimal	getPendingLeaveAccrual() The pending leave accrual associated with the LeaveSummaryRow
BigDecimal	getPendingLeaveBalance() The pending leave balance associated with the LeaveSummaryRow
BigDecimal	getPendingLeaveRequests() The pending leave requests associated with the LeaveSummaryRow
SortedMap<String,BigDecimal>	getPriorYearsTotalAccrued() The map of prior years accrued total associated with the LeaveSummaryRow
SortedMap<String,BigDecimal>	getPriorYearsUsage() The map of prior year usage associated with the LeaveSummaryRow
BigDecimal	getUsageLimit() The usage limit associated with the LeaveSummaryRow
BigDecimal	getYtdAccruedBalance() The year to date accrued balance associated with the LeaveSummaryRow
BigDecimal	getYtdApprovedUsage() The year to date approved usage associated with the LeaveSummaryRow
boolean	isPayoutable() The flag that indicates if accrued balance is eligible for payout
boolean	isTransferable() The flag that indicates if accrued balance is eligible for transfer

Method Detail

getAccrualCategory

String getAccrualCategory()

The AccrualCategory name associated with the LeaveSummaryRow

accrualCategory of a LeaveSummaryRow

Returns:

accrualCategory for LeaveSummaryRow

getAccrualCategoryId

String getAccrualCategoryId()

The AccrualCategory id associated with the LeaveSummaryRow

accrualCategoryId of a LeaveSummaryRow - used as a very simple means of getting the AccrualCategory object

Returns:

accrualCategoryId for LeaveSummaryRow

getAccrualCategoryRuleId

String getAccrualCategoryRuleId()

The AccrualCategoryRule id associated with the LeaveSummaryRow

accrualCategoryRuleId of a LeaveSummaryRow

Returns:

accrualCategoryRuleId for LeaveSummaryRow

getCarryOver

BigDecimal getCarryOver()

TODO: Make sure this comment is right The amount user can carry over to next year associated with the LeaveSummaryRow

carryOver of a LeaveSummaryRow

Returns:

carryOver for LeaveSummaryRow

getYtdAccruedBalance

BigDecimal getYtdAccruedBalance()

The year to date accrued balance associated with the LeaveSummaryRow

ytdAccruedBalance of a LeaveSummaryRow

Returns:

ytdAccruedBalance for LeaveSummaryRow

getYtdApprovedUsage

BigDecimal getYtdApprovedUsage()

The year to date approved usage associated with the LeaveSummaryRow

ytdApprovedUsage of a LeaveSummaryRow

Returns:

ytdApprovedUsage for LeaveSummaryRow

getLeaveBalance

BigDecimal getLeaveBalance()

The leave balance associated with the LeaveSummaryRow

leaveBalance of a LeaveSummaryRow

Returns:

leaveBalance for LeaveSummaryRow

getPendingLeaveAccrual

BigDecimal getPendingLeaveAccrual()

The pending leave accrual associated with the LeaveSummaryRow

pendingLeaveAccrual of a LeaveSummaryRow

Returns:

pendingLeaveAccrual for LeaveSummaryRow

getPendingLeaveRequests

BigDecimal getPendingLeaveRequests()

The pending leave requests associated with the LeaveSummaryRow

pendingLeaveRequests of a LeaveSummaryRow

Returns:

pendingLeaveRequests for LeaveSummaryRow

getPendingLeaveBalance

BigDecimal getPendingLeaveBalance()

The pending leave balance associated with the LeaveSummaryRow

pendingLeaveBalance of a LeaveSummaryRow

Returns:

pendingLeaveBalance for LeaveSummaryRow

getPendingAvailableUsage

BigDecimal getPendingAvailableUsage()

The pending available usage associated with the LeaveSummaryRow

pendingAvailableUsage of a LeaveSummaryRow

Returns:

pendingAvailableUsage for LeaveSummaryRow

getUsageLimit

BigDecimal getUsageLimit()

The usage limit associated with the LeaveSummaryRow

usageLimit of a LeaveSummaryRow

Returns:

usageLimit for LeaveSummaryRow

getFmlaUsage

BigDecimal getFmlaUsage()

The fmla usage associated with the LeaveSummaryRow

fmlaUsage of a LeaveSummaryRow

Returns:

fmlaUsage for LeaveSummaryRow

getAccruedBalance

BigDecimal getAccruedBalance()

The accrued balance associated with the LeaveSummaryRow

carryOver + ytdAccruedBalance - ytdApprovedUsage

Returns:

accrued balance for LeaveSummaryRow

isTransferable

boolean isTransferable()

The flag that indicates if accrued balance is eligible for transfer

transferable flag of a ShiftDifferentialRule

Returns:

Y if accrued balance is eligible for transfer, N if not

isPayoutable

boolean isPayoutable()

The flag that indicates if accrued balance is eligible for payout

payoutable flag of a ShiftDifferentialRule

Returns:

Y if accrued balance is eligible for payout, N if not

getPriorYearsUsage

SortedMap<String,BigDecimal> getPriorYearsUsage()

The map of prior year usage associated with the LeaveSummaryRow

priorYearsUsage of a LeaveSummaryRow

Returns:

priorYearsUsage for LeaveSummaryRow

getPriorYearsTotalAccrued

SortedMap<String,BigDecimal> getPriorYearsTotalAccrued()

The map of prior years accrued total associated with the LeaveSummaryRow

priorYearsTotalAccrued of a LeaveSummaryRow

Returns:

priorYearsTotalAccrued for LeaveSummaryRow

getMaxCarryOver

BigDecimal getMaxCarryOver()

The max carry over associated with the LeaveSummaryRow

maxCarryOver of a LeaveSummaryRow

Returns:

maxCarryOver for LeaveSummaryRow

getInfractingLeaveBlockId

String getInfractingLeaveBlockId()

TODO: Put a better comment The infractingLeaveBlockId associated with the LeaveSummaryRow

infractingLeaveBlockId of a LeaveSummaryRow

Returns:

infractingLeaveBlockId for LeaveSummaryRow