org.kuali.kpme.tklm.leave.accrual.bucket

Class YearToDateUsageLeaveBalance

java.lang.Object

org.kuali.kpme.tklm.leave.accrual.bucket.LeaveBalance

org.kuali.kpme.tklm.leave.accrual.bucket.YearToDateUsageLeaveBalance

All Implemented Interfaces:

LeaveBalanceContract, YearToDateUsageLeaveBalanceContract

public class YearToDateUsageLeaveBalance
extends LeaveBalance
implements YearToDateUsageLeaveBalanceContract

Field Summary

Fields inherited from class org.kuali.kpme.tklm.leave.accrual.bucket.LeaveBalance

accrualCategory, asOfDate, balance, calendarPeriodBeginDate, calendarPeriodEndDate, principalCalendar

Constructor Summary

Constructors

Constructor and Description
YearToDateUsageLeaveBalance(AccrualCategory accrualCategory, PrincipalHRAttributesBo principalCalendar)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(LeaveBlock leaveBlock) A hook for adding leave blocks via leave calendar action
void	adjust(LeaveBlock leaveBlock) A hook for editing leave blocks via leave calendar action
void	clear()
String	getBalanceType() The balance type associated with the LeaveBalance
void	remove(LeaveBlock leaveBlock) A hook for removing leave blocks via leave calendar action

Methods inherited from class org.kuali.kpme.tklm.leave.accrual.bucket.LeaveBalance

add, getAccrualCategory, getAccrualCategoryRuleForDate, getBalance, getEmployeeOverride, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.kpme.tklm.api.leave.accrual.bucket.LeaveBalanceContract

getAccrualCategory, getBalance

Constructor Detail

YearToDateUsageLeaveBalance

public YearToDateUsageLeaveBalance(AccrualCategory accrualCategory,
                           PrincipalHRAttributesBo principalCalendar)

Method Detail

add

public void add(LeaveBlock leaveBlock)
         throws UsageLimitException

Description copied from class: LeaveBalance

A hook for adding leave blocks via leave calendar action

Specified by:

add in class LeaveBalance

Parameters:

leaveBlock - The leave block to be added to the bucket

Throws:

UsageLimitException

remove

public void remove(LeaveBlock leaveBlock)
            throws NegativeBalanceException

Description copied from class: LeaveBalance

A hook for removing leave blocks via leave calendar action

Specified by:

remove in class LeaveBalance

Throws:

NegativeBalanceException

getBalanceType

public String getBalanceType()

Description copied from interface: LeaveBalanceContract

The balance type associated with the LeaveBalance

This is an abstract method that gets overridden in sub classes

Specified by:

getBalanceType in interface LeaveBalanceContract

Specified by:

getBalanceType in class LeaveBalance

Returns:

adjust

public void adjust(LeaveBlock leaveBlock)
            throws UsageLimitException,
                   MaximumBalanceException,
                   NegativeBalanceException

Description copied from class: LeaveBalance

A hook for editing leave blocks via leave calendar action

Specified by:

adjust in class LeaveBalance

Throws:

UsageLimitException

MaximumBalanceException

NegativeBalanceException

clear

public void clear()

Overrides:

clear in class LeaveBalance