org.kuali.kfs.integration.ld
Class LaborModuleServiceNoOp

java.lang.Object
  org.kuali.kfs.integration.ld.LaborModuleServiceNoOp

All Implemented Interfaces:

LaborModuleService

public class LaborModuleServiceNoOp
extends Object
implements LaborModuleService

Constructor Summary

LaborModuleServiceNoOp()

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LaborModuleServiceNoOp

public LaborModuleServiceNoOp()

Method Detail

calculateFringeBenefit

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

Description copied from interface: LaborModuleService

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

Specified by:

calculateFringeBenefit in interface LaborModuleService

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

calculateFringeBenefitFromLaborObject

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

Description copied from interface: LaborModuleService

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

Specified by:

calculateFringeBenefitFromLaborObject in interface LaborModuleService

Parameters:

laborLedgerObject - the given labor object

salaryAmount - the given salary amount

Returns:

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

countPendingSalaryExpenseTransfer

public int countPendingSalaryExpenseTransfer(String emplid)

Description copied from interface: LaborModuleService

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

Specified by:

countPendingSalaryExpenseTransfer in interface LaborModuleService

Parameters:

emplid - the given employee id

Returns:

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

createAndBlankApproveSalaryExpenseTransferDocument

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

Description copied from interface: LaborModuleService

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

Specified by:

createAndBlankApproveSalaryExpenseTransferDocument in interface LaborModuleService

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

doesLaborLedgerPositionObjectGroupExist

public boolean doesLaborLedgerPositionObjectGroupExist(String positionObjectGroupCode)

Description copied from interface: LaborModuleService

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

Specified by:

doesLaborLedgerPositionObjectGroupExist in interface LaborModuleService

Parameters:

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

Returns:

true if the position object group exists, false otherwise

findEmployeesWithPayType

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

Description copied from interface: LaborModuleService

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.

Specified by:

findEmployeesWithPayType in interface LaborModuleService

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

findLedgerBalances

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

Description copied from interface: LaborModuleService

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

Specified by:

findLedgerBalances in interface LaborModuleService

Parameters:

fieldValues - the given field values

excludedFieldValues - the given field values that must not be matched

fiscalYears - the given fiscal years

positionObjectGroupCodes - the specified position obejct group codes

Returns:

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

hasFringeBenefitProducingObjectCodes

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

Description copied from interface: LaborModuleService

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

Specified by:

hasFringeBenefitProducingObjectCodes in interface LaborModuleService

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

hasPendingLaborLedgerEntry

public boolean hasPendingLaborLedgerEntry(String chartOfAccountsCode,
                                          String accountNumber)

Description copied from interface: LaborModuleService

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

Specified by:

hasPendingLaborLedgerEntry in interface LaborModuleService

Returns:

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

isEmployeeWithPayType

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

Description copied from interface: LaborModuleService

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.

Specified by:

isEmployeeWithPayType in interface LaborModuleService

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

retrieveLaborLedgerObject

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

Description copied from interface: LaborModuleService

retrieves a specific LaborLedgerObject from the database using primary key

Specified by:

retrieveLaborLedgerObject in interface LaborModuleService

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

public LaborLedgerObject retrieveLaborLedgerObject(ObjectCode financialObject)

Description copied from interface: LaborModuleService

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

Specified by:

retrieveLaborLedgerObject in interface LaborModuleService

Parameters:

financialObject - the given financial object

Returns:

a labor object retrieved based on the given information

retrieveLaborPositionObjectBenefits

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

Description copied from interface: LaborModuleService

Retrieves LaborLedgerPositionObjectBenefits for a LaborLedgerObject key

Specified by:

retrieveLaborPositionObjectBenefits in interface LaborModuleService

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