org.kuali.kfs.module.ec.batch.service
Interface EffortCertificationExtractService

All Known Implementing Classes:

EffortCertificationExtractServiceImpl

public interface EffortCertificationExtractService

The interface defines the methods that extract Labor Ledger records of the employees who were paid on a grant or cost shared during the selected reporting period.

Method Summary

void	extract() extract Labor Ledger records of the employees who were paid on a grant or cost shared during a reporting period.
void	extract(Integer fiscalYear, String reportNumber) extract Labor Ledger records of the employees who were paid on a grant or cost shared during a reporting period.
EffortCertificationDocumentBuild	extract(String emplid, EffortCertificationReportDefinition effortCertificationReportDefiniton) extract Labor Ledger records of the given employee for the given report definition, and create effort certification document build.
List<String>	findEmployeesEligibleForEffortCertification(EffortCertificationReportDefinition reportDefinition) find the employees who were paid based on a set of specified pay type within the given report periods.
boolean	isEmployeeEligibleForEffortCertification(String emplid, EffortCertificationReportDefinition reportDefinition) determine whether the given employee is eligible for effort certification within the given report periods.

Method Detail

extract

void extract()

extract Labor Ledger records of the employees who were paid on a grant or cost shared during a reporting period. The reporting period can be determined by both of fiscal year and report number declared as system parameters.

extract

void extract(Integer fiscalYear,
             String reportNumber)

extract Labor Ledger records of the employees who were paid on a grant or cost shared during a reporting period. The reporting period can be determined by both of fiscal year and report number.

Parameters:

fiscalYear - the given fiscal year with which Labor ledgers can be extracted.

reportNumber - the given report number to run.

extract

EffortCertificationDocumentBuild extract(String emplid,
                                         EffortCertificationReportDefinition effortCertificationReportDefiniton)

extract Labor Ledger records of the given employee for the given report definition, and create effort certification document build.

Parameters:

emplid - the given employee id

effortCertificationReportDefiniton - the given report definition

Returns:

an effort certification document build generated for the given employee

findEmployeesEligibleForEffortCertification

List<String> findEmployeesEligibleForEffortCertification(EffortCertificationReportDefinition reportDefinition)

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. The employees are eligible for effort certification.

Parameters:

reportDefinition - the specified report definition

Returns:

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

isEmployeeEligibleForEffortCertification

boolean isEmployeeEligibleForEffortCertification(String emplid,
                                                 EffortCertificationReportDefinition reportDefinition)

determine whether the given employee is eligible for effort certification within the given report periods. Here, a pay type can be determined by earn code and pay group.

Parameters:

emplid - the given employee id

reportDefinition - the specified report definition

Returns:

true if the given employee is eligible for effort certification within the given report periods; otherwise, false