org.kuali.kfs.integration.ld
Interface LaborModuleService

All Known Implementing Classes:

LaborModuleServiceImpl, LaborModuleServiceNoOp

public interface LaborModuleService

This interface is exposing the service methods that may be used by the modules outside of labor

Method Summary

org.kuali.rice.kns.util.KualiDecimal	calculateFringeBenefit(Integer fiscalYear, String chartCode, String objectCode, org.kuali.rice.kns.util.KualiDecimal salaryAmount) calculate the fringe benefit amount for the given object code and salary amount
org.kuali.rice.kns.util.KualiDecimal	calculateFringeBenefitFromLaborObject(LaborLedgerObject laborLedgerObject, org.kuali.rice.kns.util.KualiDecimal salaryAmount) calculate the fringe benefit amount for the given labor object and salary amount
int	countPendingSalaryExpenseTransfer(String emplid) get the document numbers of the pending salary expense transfer documents for the given employee
void	createAndBlankApproveSalaryExpenseTransferDocument(String documentDescription, String explanation, String annotation, List<String> adHocRecipients, List<LaborLedgerExpenseTransferAccountingLine> sourceAccoutingLines, List<LaborLedgerExpenseTransferAccountingLine> targetAccoutingLines) create and approve a salary expense transfer document generated from the given accounting lines
boolean	doesLaborLedgerPositionObjectGroupExist(String positionObjectGroupCode) Determines where a Labor Ledger postion object group with the given code actually exists.
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.
Collection<LaborLedgerBalance>	findLedgerBalances(Map<String,List<String>> fieldValues, Map<String,List<String>> excludedFieldValues, Set<Integer> fiscalYears, List<String> balanceTypes, List<String> positionObjectGroupCodes) find all ledger balances matching the given criteria within the given fiscal years
boolean	hasFringeBenefitProducingObjectCodes(Integer fiscalYear, String chartOfAccountsCode, String financialObjectCode) Determines whether the given set of accounting lines have object codes that receieve fringe benefits
boolean	hasPendingLaborLedgerEntry(String chartOfAccountsCode, String accountNumber) Does the given account have any labor ledger entries? It is necessary to check this before closing an account.
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.
LaborLedgerObject	retrieveLaborLedgerObject(Integer fiscalYear, String chartOfAccountsCode, String objectCode) retrieves a specific LaborLedgerObject from the database using primary key
LaborLedgerObject	retrieveLaborLedgerObject(ObjectCode financialObject) retrieves a specific LaborLedgerObject based on the information of the given financial object
List<LaborLedgerPositionObjectBenefit>	retrieveLaborPositionObjectBenefits(Integer fiscalYear, String chartOfAccountsCode, String objectCode) Retrieves LaborLedgerPositionObjectBenefits for a LaborLedgerObject key

Method Detail

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

findLedgerBalances

Collection<LaborLedgerBalance> findLedgerBalances(Map<String,List<String>> fieldValues,
                                                  Map<String,List<String>> excludedFieldValues,
                                                  Set<Integer> fiscalYears,
                                                  List<String> balanceTypes,
                                                  List<String> positionObjectGroupCodes)

find all ledger balances matching the given criteria within the given fiscal years

Parameters:

fieldValues - the given field values

excludedFieldValues - the given field values that must not be matched

fiscalYears - the given fiscal years

balanceTypeList - the given balance type code list

positionObjectGroupCodes - the specified position obejct group codes

Returns:

all ledger balances matching the given criteria within the given fiscal years

calculateFringeBenefitFromLaborObject

org.kuali.rice.kns.util.KualiDecimal calculateFringeBenefitFromLaborObject(LaborLedgerObject laborLedgerObject,
                                                                           org.kuali.rice.kns.util.KualiDecimal salaryAmount)

calculate the fringe benefit amount for the given labor object and salary amount

Parameters:

laborLedgerObject - the given labor object

salaryAmount - the given salary amount

Returns:

the fringe benefit amount for the given labor object and salary amount

calculateFringeBenefit

org.kuali.rice.kns.util.KualiDecimal calculateFringeBenefit(Integer fiscalYear,
                                                            String chartCode,
                                                            String objectCode,
                                                            org.kuali.rice.kns.util.KualiDecimal salaryAmount)

calculate the fringe benefit amount for the given object code and salary amount

Parameters:

fiscalYear - the year for object code record

chartCode - the chart for object code record

objectCode - the object code

salaryAmount - amount to calculate benefits for

Returns:

the fringe benefit amount

createAndBlankApproveSalaryExpenseTransferDocument

void createAndBlankApproveSalaryExpenseTransferDocument(String documentDescription,
                                                        String explanation,
                                                        String annotation,
                                                        List<String> adHocRecipients,
                                                        List<LaborLedgerExpenseTransferAccountingLine> sourceAccoutingLines,
                                                        List<LaborLedgerExpenseTransferAccountingLine> targetAccoutingLines)
                                                        throws org.kuali.rice.kew.exception.WorkflowException

create and approve a salary expense transfer document generated from the given accounting lines

Parameters:

documentDescription - the description about the generated document

explanation - the explanation for the document

annotation - the annotation as acknowledgement

adHocRecipients - the given ad-hoc recipients who will be acknowledged about the document

sourceAccoutingLines - the given source accounting lines used to populate document

targetAccoutingLines - the given target accounting lines used to populate document

Throws:

org.kuali.rice.kew.exception.WorkflowException - occurs if the document is failed to be routed for approval

countPendingSalaryExpenseTransfer

int countPendingSalaryExpenseTransfer(String emplid)

get the document numbers of the pending salary expense transfer documents for the given employee

Parameters:

emplid - the given employee id

Returns:

the document numbers of the pending salary expense transfer documents for the given employee

retrieveLaborLedgerObject

LaborLedgerObject retrieveLaborLedgerObject(Integer fiscalYear,
                                            String chartOfAccountsCode,
                                            String objectCode)

retrieves a specific LaborLedgerObject from the database using primary key

Parameters:

fiscalYear - the given fiscal year

chartOfAccountsCode - the given chart of accounts code

objectCode - the given object code

Returns:

a labor object retrieved based on the given information

retrieveLaborLedgerObject

LaborLedgerObject retrieveLaborLedgerObject(ObjectCode financialObject)

retrieves a specific LaborLedgerObject based on the information of the given financial object

Parameters:

financialObject - the given financial object

Returns:

a labor object retrieved based on the given information

retrieveLaborPositionObjectBenefits

List<LaborLedgerPositionObjectBenefit> retrieveLaborPositionObjectBenefits(Integer fiscalYear,
                                                                           String chartOfAccountsCode,
                                                                           String objectCode)

Retrieves LaborLedgerPositionObjectBenefits for a LaborLedgerObject key

Parameters:

fiscalYear - the given fiscal year

chartOfAccountsCode - the given chart of accounts code

objectCode - the given object code

Returns:

a labor position object benefit retrieved based on the given information

hasPendingLaborLedgerEntry

boolean hasPendingLaborLedgerEntry(String chartOfAccountsCode,
                                   String accountNumber)

Does the given account have any labor ledger entries? It is necessary to check this before closing an account.

Parameters:

account - the given account

Returns:

true if there is a pending entry for the given account; otherwise, return false

hasFringeBenefitProducingObjectCodes

boolean hasFringeBenefitProducingObjectCodes(Integer fiscalYear,
                                             String chartOfAccountsCode,
                                             String financialObjectCode)

Determines whether the given set of accounting lines have object codes that receieve fringe benefits

Parameters:

fiscalYear - the fiscal year of the document

chartOfAccountsCode - chart of accounts code to check

financialObjectCode - financialObjectCode to check

Returns:

true if the lines include lines with labor object codes, false otherwise

doesLaborLedgerPositionObjectGroupExist

boolean doesLaborLedgerPositionObjectGroupExist(String positionObjectGroupCode)

Determines where a Labor Ledger postion object group with the given code actually exists.

Parameters:

positionObjectGroupCode - the code of the position object group to check for existence

Returns:

true if the position object group exists, false otherwise