org.kuali.hr.lm.leavepayout.service
Interface LeavePayoutService

All Known Implementing Classes:

LeavePayoutServiceImpl

public interface LeavePayoutService

Method Summary

List<LeavePayout>	getAllLeavePayoutsByEffectiveDate(Date effectiveDate)
List<LeavePayout>	getAllLeavePayoutsForPrincipalId(String principalId)
List<LeavePayout>	getAllLeavePayoutsForPrincipalIdAsOfDate(String principalId, Date effectiveDate)
Map<String,ArrayList<String>>	getEligiblePayouts(CalendarEntries calendarEntry, String principalId) Determines which accrual categories within the given leave calendar document, are TRANSFERABLE for the given action frequency.
LeavePayout	getLeavePayoutById(String lmLeavePayoutId)
List<LeavePayout>	getLeavePayouts(String viewPrincipal, Date beginPeriodDate, Date endPeriodDate)
LeavePayout	initializePayout(String principalId, String accrualCategoryRule, BigDecimal accruedBalance, Date effectiveDate) A service that instantiates and returns LeavePayout objects that follow the given accrual category rule.
LeavePayout	payout(LeavePayout leavePayout) Consumes a LeavePayout object, creating up to three leave blocks.
void	saveOrUpdate(LeavePayout payout)
void	submitToWorkflow(LeavePayout leavePayout)

Method Detail

getAllLeavePayoutsForPrincipalId

List<LeavePayout> getAllLeavePayoutsForPrincipalId(String principalId)

getAllLeavePayoutsForPrincipalIdAsOfDate

List<LeavePayout> getAllLeavePayoutsForPrincipalIdAsOfDate(String principalId,
                                                           Date effectiveDate)

getAllLeavePayoutsByEffectiveDate

List<LeavePayout> getAllLeavePayoutsByEffectiveDate(Date effectiveDate)

getLeavePayoutById

LeavePayout getLeavePayoutById(String lmLeavePayoutId)

initializePayout

LeavePayout initializePayout(String principalId,
                             String accrualCategoryRule,
                             BigDecimal accruedBalance,
                             Date effectiveDate)

A service that instantiates and returns LeavePayout objects that follow the given accrual category rule.

Parameters:

principalId - The principal this transfer pertains to.

accrualCategoryRule - The accrual category rule that contains the max balance information.

leaveSummary - Holds balance information needed for transfer.

effectiveDate -

Returns:

A LeavePayout object conforming to @param accrualCategoryRule, if one exists. Null otherwise. The transfer amount will be the minimum of: 1.) the accrual category rule's maximum transfer amount, adjusted for the employees FTE. 2.) the number of time units exceeding the maximum balance

payout

LeavePayout payout(LeavePayout leavePayout)

Consumes a LeavePayout object, creating up to three leave blocks.

Parameters:

LeavePayout - The LeavePayout object to use for transfer.

Returns:

The same LeavePayout object, but with associated leave block ids.

getEligiblePayouts

Map<String,ArrayList<String>> getEligiblePayouts(CalendarEntries calendarEntry,
                                                 String principalId)
                                                 throws Exception

Determines which accrual categories within the given leave calendar document, are TRANSFERABLE for the given action frequency. Includes accrual categories for which ACTION_AT_MAX_BALANCE = LOSE.

Parameters:

document - The LeaveCalendarDocument to use in gathering transfer eligible accrual categories.

actionFrequency - One of LMConstants.MAX_BAL_ACTION_FREQ

Returns:

A List of accrualCategoryRuleId's in 's leave summary with MAX_BAL_ACTION_FREQUENCY =

Throws:

Exception

submitToWorkflow

void submitToWorkflow(LeavePayout leavePayout)
                      throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

getLeavePayouts

List<LeavePayout> getLeavePayouts(String viewPrincipal,
                                  Date beginPeriodDate,
                                  Date endPeriodDate)

saveOrUpdate

void saveOrUpdate(LeavePayout payout)