org.kuali.kfs.module.ld.service.impl

Class LaborModuleServiceImpl

java.lang.Object

org.kuali.kfs.module.ld.service.impl.LaborModuleServiceImpl

All Implemented Interfaces:

LaborModuleService

@Transactional
public class LaborModuleServiceImpl
extends Object
implements LaborModuleService

This implements the service methods that may be used by outside of labor module

Constructor Summary

Constructors

Constructor and Description
LaborModuleServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.kuali.rice.krad.bo.AdHocRouteRecipient	buildApprovePersonRecipient(String userId) This method builds a recipient for Approval.
org.kuali.rice.core.api.util.type.KualiDecimal	calculateFringeBenefit(Integer fiscalYear, String chartCode, String objectCode, org.kuali.rice.core.api.util.type.KualiDecimal salaryAmount, String accountNumber, String subAccountNumber) calculate the fringe benefit amount for the given object code and salary amount
org.kuali.rice.core.api.util.type.KualiDecimal	calculateFringeBenefitFromLaborObject(LaborLedgerObject laborLedgerObject, org.kuali.rice.core.api.util.type.KualiDecimal salaryAmount, String accountNumber, String subAccountNumber) 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> sourceAccountingLines, List<LaborLedgerExpenseTransferAccountingLine> targetAccountingLines) create and approve a salary expense transfer document generated from the given accounting lines
AccountingLineOverride	determineNeededOverrides(AccountingDocument document, AccountingLine line)
AccountingLineOverride	determineNeededOverrides(AccountingLine line) Deprecated.
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,Collection<String>> fieldValues, Map<String,Collection<String>> excludedFieldValues, Set<Integer> fiscalYears, List<String> balanceTypes, List<String> positionObjectGroupCodes) find all ledger balances matching the given criteria within the given fiscal years
String	getBenefitRateCategoryCode(String chartOfAccountsCode, String accountNumber, String subAccountNumber)
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Gets the businessObjectService attribute.
String	getCostSharingSourceAccountNumber()
String	getCostSharingSourceChartOfAccountsCode()
String	getCostSharingSourceSubAccountNumber()
org.kuali.rice.kns.service.DataDictionaryService	getDataDictionaryService() Gets the dataDictionaryService attribute.
org.kuali.rice.krad.service.DocumentService	getDocumentService() Gets the documentService attribute.
org.kuali.rice.kns.lookup.HtmlData	getInquiryUrlForGeneralLedgerEntryDocumentNumber(Entry entry) Builds the url for the given GL entry to go to inquiry screen for related LD entries
org.kuali.rice.krad.service.KualiModuleService	getKualiModuleService() Gets the KualiModuleService attribute value.
LaborBenefitsCalculationService	getLaborBenefitsCalculationService() Gets the laborBenefitsCalculationService attribute.
LaborLedgerBalanceService	getLaborLedgerBalanceService() Gets the laborLedgerBalanceService attribute.
LaborLedgerEntryService	getLaborLedgerEntryService() Gets the laborLedgerEntryService attribute.
Collection<String>	getLaborLedgerGLOriginCodes() Looks up the origin codes from the parameter KFS-LD / LedgerEntry / LINK_DOCUMENT_NUMBER_TO_LABOR_ORIGIN_CODES
LaborLedgerPendingEntryService	getLaborLedgerPendingEntryService() Gets the laborLedgerPendingEntryService
LaborLedgerPositionObjectGroup	getLaborLedgerPositionObjectGroup(String positionObjectGroupCode)
LaborOriginEntryService	getLaborOriginEntryService() Returns an instance of the LaborOriginEntryService, for use by services in the module
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
UniversityDateService	getUniversityDateService() Gets the universityDateService attribute.
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.
List<LaborLedgerPositionObjectBenefit>	retrieveActiveLaborPositionObjectBenefits(Integer fiscalYear, String chartOfAccountsCode, String objectCode)
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

LaborModuleServiceImpl

public LaborModuleServiceImpl()

Method Detail

calculateFringeBenefitFromLaborObject

public org.kuali.rice.core.api.util.type.KualiDecimal calculateFringeBenefitFromLaborObject(LaborLedgerObject laborLedgerObject,
                                                                                   org.kuali.rice.core.api.util.type.KualiDecimal salaryAmount,
                                                                                   String accountNumber,
                                                                                   String subAccountNumber)

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

See Also:

org.kuali.kfs.integration.ld.LaborModuleService#calculateFringeBenefitFromLaborObject(org.kuali.kfs.integration.ld.LaborLedgerObject, org.kuali.rice.core.api.util.type.KualiDecimal)

calculateFringeBenefit

public org.kuali.rice.core.api.util.type.KualiDecimal calculateFringeBenefit(Integer fiscalYear,
                                                                    String chartCode,
                                                                    String objectCode,
                                                                    org.kuali.rice.core.api.util.type.KualiDecimal salaryAmount,
                                                                    String accountNumber,
                                                                    String subAccountNumber)

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

See Also:

org.kuali.kfs.integration.ld.LaborModuleService#calculateFringeBenefit(java.lang.Integer, java.lang.String, java.lang.String, org.kuali.rice.core.api.util.type.KualiDecimal)

createAndBlankApproveSalaryExpenseTransferDocument

public void createAndBlankApproveSalaryExpenseTransferDocument(String documentDescription,
                                                      String explanation,
                                                      String annotation,
                                                      List<String> adHocRecipients,
                                                      List<LaborLedgerExpenseTransferAccountingLine> sourceAccountingLines,
                                                      List<LaborLedgerExpenseTransferAccountingLine> targetAccountingLines)
                                                        throws org.kuali.rice.kew.api.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

sourceAccountingLines - the given source accounting lines used to populate document

targetAccountingLines - the given target accounting lines used to populate document

Throws:

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

See Also:

LaborModuleService.createAndBlankApproveSalaryExpenseTransferDocument(java.lang.String, java.lang.String, java.lang.String, java.util.List, java.util.List, java.util.List)

buildApprovePersonRecipient

protected org.kuali.rice.krad.bo.AdHocRouteRecipient buildApprovePersonRecipient(String userId)

This method builds a recipient for Approval.

Parameters:

userId -

Returns:

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

See Also:

LaborModuleService.countPendingSalaryExpenseTransfer(java.lang.String)

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

See Also:

LaborModuleService.findEmployeesWithPayType(java.util.Map, java.util.List, java.util.Map)

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

See Also:

LaborModuleService.isEmployeeWithPayType(java.lang.String, java.util.Map, java.util.List, java.util.Map)

findLedgerBalances

public Collection<LaborLedgerBalance> findLedgerBalances(Map<String,Collection<String>> fieldValues,
                                                Map<String,Collection<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

See Also:

LaborModuleService.findLedgerBalances(java.util.Map, java.util.Map, java.util.Set, java.util.List, java.util.List)

getLaborLedgerPositionObjectGroup

public LaborLedgerPositionObjectGroup getLaborLedgerPositionObjectGroup(String positionObjectGroupCode)

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

See Also:

org.kuali.kfs.integration.service.LaborModuleService#doesLaborLedgerPositionObjectGroupExist(java.lang.String)

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

See Also:

LaborModuleService.retrieveLaborLedgerObject(java.lang.Integer, java.lang.String, java.lang.String)

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

See Also:

LaborModuleService.retrieveLaborLedgerObject(org.kuali.kfs.coa.businessobject.ObjectCode)

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

See Also:

LaborModuleService.hasPendingLaborLedgerEntry(java.lang.String, java.lang.String)

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

See Also:

LaborModuleService.retrieveLaborPositionObjectBenefits(java.lang.Integer, java.lang.String, java.lang.String)

retrieveActiveLaborPositionObjectBenefits

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

Specified by:

retrieveActiveLaborPositionObjectBenefits in interface LaborModuleService

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

See Also:

LaborModuleService.hasFringeBenefitProducingObjectCodes(java.lang.Integer, java.lang.String, java.lang.String)

getLaborLedgerGLOriginCodes

public Collection<String> getLaborLedgerGLOriginCodes()

Looks up the origin codes from the parameter KFS-LD / LedgerEntry / LINK_DOCUMENT_NUMBER_TO_LABOR_ORIGIN_CODES

Specified by:

getLaborLedgerGLOriginCodes in interface LaborModuleService

Returns:

a list of labor ledger oriented origin codes which appear on general ledger entries

See Also:

LaborModuleService.getLaborLedgerGLOriginCodes()

getInquiryUrlForGeneralLedgerEntryDocumentNumber

public org.kuali.rice.kns.lookup.HtmlData getInquiryUrlForGeneralLedgerEntryDocumentNumber(Entry entry)

Builds the url for the given GL entry to go to inquiry screen for related LD entries

Specified by:

getInquiryUrlForGeneralLedgerEntryDocumentNumber in interface LaborModuleService

Parameters:

entry - an entry to find a labor ledger inquiry on the document number was

Returns:

the inquiry HtmlData for the given general ledger entry

See Also:

LaborModuleService.getInquiryUrlForGeneralLedgerEntryDocumentNumber(org.kuali.kfs.gl.businessobject.Entry)

getLaborBenefitsCalculationService

public LaborBenefitsCalculationService getLaborBenefitsCalculationService()

Gets the laborBenefitsCalculationService attribute.

Returns:

an implementation of the laborBenefitsCalculationService.

getLaborLedgerEntryService

public LaborLedgerEntryService getLaborLedgerEntryService()

Gets the laborLedgerEntryService attribute.

Returns:

an implementation of the laborLedgerEntryService.

getLaborLedgerBalanceService

public LaborLedgerBalanceService getLaborLedgerBalanceService()

Gets the laborLedgerBalanceService attribute.

Returns:

an implementation of the laborLedgerBalanceService.

getDocumentService

public org.kuali.rice.krad.service.DocumentService getDocumentService()

Gets the documentService attribute.

Returns:

an implementation of the documentService.

getDataDictionaryService

public org.kuali.rice.kns.service.DataDictionaryService getDataDictionaryService()

Gets the dataDictionaryService attribute.

Returns:

an implementation of the dataDictionaryService.

getUniversityDateService

public UniversityDateService getUniversityDateService()

Gets the universityDateService attribute.

Returns:

an implementation of the universityDateService.

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

Gets the businessObjectService attribute.

Returns:

an implementation of the businessObjectService.

getLaborLedgerPendingEntryService

public LaborLedgerPendingEntryService getLaborLedgerPendingEntryService()

Gets the laborLedgerPendingEntryService

Returns:

an implementation of the LaborLedgerPendingEntryService

getLaborOriginEntryService

public LaborOriginEntryService getLaborOriginEntryService()

Returns an instance of the LaborOriginEntryService, for use by services in the module

Returns:

an instance of an implementation of the LaborOriginEntryService

getParameterService

public org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Returns:

the default implementation of the ParameterService

getKualiModuleService

public org.kuali.rice.krad.service.KualiModuleService getKualiModuleService()

Gets the KualiModuleService attribute value.

Returns:

an implementation of the KualiModuleService.

getBenefitRateCategoryCode

public String getBenefitRateCategoryCode(String chartOfAccountsCode,
                                String accountNumber,
                                String subAccountNumber)

Specified by:

getBenefitRateCategoryCode in interface LaborModuleService

getCostSharingSourceAccountNumber

public String getCostSharingSourceAccountNumber()

Specified by:

getCostSharingSourceAccountNumber in interface LaborModuleService

getCostSharingSourceSubAccountNumber

public String getCostSharingSourceSubAccountNumber()

Specified by:

getCostSharingSourceSubAccountNumber in interface LaborModuleService

getCostSharingSourceChartOfAccountsCode

public String getCostSharingSourceChartOfAccountsCode()

Specified by:

getCostSharingSourceChartOfAccountsCode in interface LaborModuleService

determineNeededOverrides

public AccountingLineOverride determineNeededOverrides(AccountingDocument document,
                                              AccountingLine line)

Specified by:

determineNeededOverrides in interface LaborModuleService

determineNeededOverrides

@Deprecated
public AccountingLineOverride determineNeededOverrides(AccountingLine line)

Deprecated.

Specified by:

determineNeededOverrides in interface LaborModuleService