org.kuali.kfs.module.ld.service
Interface LaborLedgerEntryService

All Known Implementing Classes:

LaborLedgerEntryServiceImpl

public interface LaborLedgerEntryService

This interface provides its clients with access to labor leger entries in the backend data store.

Method Summary

void	deleteLedgerEntriesPriorToYear(Integer fiscalYear, String chartOfAccountsCode) delete the ledger entry records that were posted prior to the given fiscal year
Iterator<LedgerEntry>	find(Map<String,String> fieldValues) Find the ledger entries that satisfy the all entries in the given field-value pair
List<String>	findEmployeesWithPayType(Map<Integer,Set<String>> payPeriods, List<String> balanceTypes, Map<String,Set<String>> earnCodePayGroupMap) find the employees who were paid based on a set of specified pay type within the given report periods.
Integer	getMaxSequenceNumber(LedgerEntry ledgerEntry) The sequence number is one of the primary keys of ledger entry.
boolean	isEmployeeWithPayType(String emplid, Map<Integer,Set<String>> payPeriods, List<String> balanceTypes, Map<String,Set<String>> earnCodePayGroupMap) determine whether the given employee was paid based on a set of specified pay type within the given report periods.
void	save(LedgerEntry ledgerEntry) Save the given ledger entry or update it if it exsits

Method Detail

save

void save(LedgerEntry ledgerEntry)

Save the given ledger entry or update it if it exsits

Parameters:

ledgerEntry - the given ledger entry

getMaxSequenceNumber

Integer getMaxSequenceNumber(LedgerEntry ledgerEntry)

The sequence number is one of the primary keys of ledger entry. The entries can be grouped by other keys. This method is used to get the maximum sequence number in the group of entries.

Parameters:

ledgerEntry - the given ledger entry

Returns:

the maximum sequence number in a group of entries. If the group doesn't exist, return 0.

find

Iterator<LedgerEntry> find(Map<String,String> fieldValues)

Find the ledger entries that satisfy the all entries in the given field-value pair

Parameters:

fieldValues - the given field-value pair

Returns:

the ledger entries that satisfy the all entries in the given field-value pair

findEmployeesWithPayType

List<String> findEmployeesWithPayType(Map<Integer,Set<String>> payPeriods,
                                      List<String> balanceTypes,
                                      Map<String,Set<String>> earnCodePayGroupMap)

find the employees who were paid based on a set of specified pay type within the given report periods. Here, a pay type can be determined by earn code and pay group.

Parameters:

payPeriods - the given pay periods

balanceTypes - the specified balance type codes

earnCodePayGroupMap - the combination of earn codes and pay groups, where pay group is the key and earn code set is the value

Returns:

the employees who were paid based on a set of specified pay type within the given report periods

isEmployeeWithPayType

boolean isEmployeeWithPayType(String emplid,
                              Map<Integer,Set<String>> payPeriods,
                              List<String> balanceTypes,
                              Map<String,Set<String>> earnCodePayGroupMap)

determine whether the given employee was paid based on a set of specified pay type within the given report periods. Here, a pay type can be determined by earn code and pay group.

Parameters:

emplid - the given employee id

payPeriods - the given pay periods

balanceTypes - the specified balance type codes

earnCodePayGroupMap - the combination of earn codes and pay groups, where pay group is the key and earn code set is the value

Returns:

true if the given employee was paid based on a set of specified pay type within the given report periods; otherwise, false

deleteLedgerEntriesPriorToYear

void deleteLedgerEntriesPriorToYear(Integer fiscalYear,
                                    String chartOfAccountsCode)

delete the ledger entry records that were posted prior to the given fiscal year

Parameters:

fiscalYear - the given fiscal year

chartOfAccountsCode - the given chart of account code