org.kuali.hr.lm.balancetransfer.service
Interface BalanceTransferService

All Known Implementing Classes:

BalanceTransferServiceImpl

public interface BalanceTransferService

Method Summary

List<BalanceTransfer>	getAllBalanceTransferByEffectiveDate(Date effectiveDate)
List<BalanceTransfer>	getAllBalanceTransferForPrincipalIdAsOfDate(String principalId, Date effectiveDate)
List<BalanceTransfer>	getAllBalanceTransfersForPrincipalId(String principalId)
BalanceTransfer	getBalanceTransferById(String balanceTransferId)
List<BalanceTransfer>	getBalanceTransfers(String viewPrincipal, Date beginPeriodDate, Date endPeriodDate)
Map<String,ArrayList<String>>	getEligibleTransfers(CalendarEntries calendarEntry, String principalId) Determines which accrual categories within the given leave calendar document, are TRANSFERABLE for the given action frequency.
BalanceTransfer	initializeTransfer(String principalId, String accrualCategoryRule, BigDecimal accruedBalance, Date effectiveDate) A service that instantiates and returns BalanceTransfer objects that follow the given accrual category rule.
void	saveOrUpdate(BalanceTransfer balanceTransfer)
void	submitToWorkflow(BalanceTransfer balanceTransfer)
BalanceTransfer	transfer(BalanceTransfer balanceTransfer) Consumes a BalanceTransfer object, creating up to three leave blocks.
BalanceTransfer	transferSsto(BalanceTransfer balanceTransfer) transfer system scheduled time off

Method Detail

getAllBalanceTransfersForPrincipalId

List<BalanceTransfer> getAllBalanceTransfersForPrincipalId(String principalId)

getAllBalanceTransferForPrincipalIdAsOfDate

List<BalanceTransfer> getAllBalanceTransferForPrincipalIdAsOfDate(String principalId,
                                                                  Date effectiveDate)

getAllBalanceTransferByEffectiveDate

List<BalanceTransfer> getAllBalanceTransferByEffectiveDate(Date effectiveDate)

saveOrUpdate

void saveOrUpdate(BalanceTransfer balanceTransfer)

getBalanceTransferById

BalanceTransfer getBalanceTransferById(String balanceTransferId)

initializeTransfer

BalanceTransfer initializeTransfer(String principalId,
                                   String accrualCategoryRule,
                                   BigDecimal accruedBalance,
                                   Date effectiveDate)

A service that instantiates and returns BalanceTransfer 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.

accruedBalance - Holds balance information needed for transfer.

effectiveDate -

Returns:

A BalanceTransfer 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

transfer

BalanceTransfer transfer(BalanceTransfer balanceTransfer)

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

Parameters:

balanceTransfer - The BalanceTransfer object to use for transfer.

Returns:

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

getEligibleTransfers

Map<String,ArrayList<String>> getEligibleTransfers(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(BalanceTransfer balanceTransfer)
                      throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

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

transferSsto

BalanceTransfer transferSsto(BalanceTransfer balanceTransfer)

transfer system scheduled time off

Parameters:

balanceTransfer -

Returns:

getBalanceTransfers

List<BalanceTransfer> getBalanceTransfers(String viewPrincipal,
                                          Date beginPeriodDate,
                                          Date endPeriodDate)