org.kuali.kfs.module.ec.service
Interface EffortCertificationReportDefinitionService

All Known Implementing Classes:

EffortCertificationReportDefinitionServiceImpl

public interface EffortCertificationReportDefinitionService

Define the services that are related to EffortCertificationReportDefinition

Method Summary

List<String>	findPositionObjectGroupCodes(EffortCertificationReportDefinition reportDefinition) find all position object group codes for the given report definition
EffortCertificationReportDefinition	findReportDefinitionByPrimaryKey(Map<String,String> fieldValues) find a report definition by the primary key.
Map<String,Set<String>>	findReportEarnCodePayGroups(EffortCertificationReportDefinition reportDefinition) store the earn code and pay group combination in a Map for the specified report definition
Collection<EffortCertificationReportEarnPaygroup>	findReportEarnPay(EffortCertificationReportDefinition reportDefinition) find the earn code and pay group combination for the specified report definition
boolean	hasApprovedEffortCertification(String emplid, EffortCertificationReportDefinition reportDefinition) determine whether there is any approved effort certification for the given report definition and employee
boolean	hasBeenUsedForEffortCertificationGeneration(EffortCertificationReportDefinition reportDefinition) determine whether the given report definition has been used to generate effort certification document
boolean	hasBeenUsedForEffortCertificationGeneration(String emplid, EffortCertificationReport reportDefinition) determine whether the given report definition has been used to generate effort certification documents for the given employee
boolean	hasPendingEffortCertification(String emplid, EffortCertificationReportDefinition reportDefinition) determine whether there is any pending/temporary effort certification waiting for the given report definition
String	validateEffortCertificationReportDefinition(EffortCertificationReportDefinition effortCertificationReportDefinition) check if an effort certification report has been defined.

Method Detail

findReportDefinitionByPrimaryKey

EffortCertificationReportDefinition findReportDefinitionByPrimaryKey(Map<String,String> fieldValues)

find a report definition by the primary key. The primary key is provided by the given field values.

Parameters:

fieldValues - the given field values containing the primary key of a report definition

Returns:

a report definition with the given primary key

validateEffortCertificationReportDefinition

String validateEffortCertificationReportDefinition(EffortCertificationReportDefinition effortCertificationReportDefinition)

check if an effort certification report has been defined.

Parameters:

effortCertificationReportDefinition - the given effort certification report definition

Returns:

a message if a report has not been defined; otherwise, return null

findPositionObjectGroupCodes

List<String> findPositionObjectGroupCodes(EffortCertificationReportDefinition reportDefinition)

find all position object group codes for the given report definition

Parameters:

reportDefinition - the specified report definition

Returns:

all position object group codes for the given report definition

findReportEarnCodePayGroups

Map<String,Set<String>> findReportEarnCodePayGroups(EffortCertificationReportDefinition reportDefinition)

store the earn code and pay group combination in a Map for the specified report definition

Parameters:

reportDefinition - the specified report definition

Returns:

the earn code and pay group combination for the specified report definition as a Map

findReportEarnPay

Collection<EffortCertificationReportEarnPaygroup> findReportEarnPay(EffortCertificationReportDefinition reportDefinition)

find the earn code and pay group combination for the specified report definition

Parameters:

reportDefinition - the specified report definition

Returns:

the earn code and pay group combination for the specified report definition

hasBeenUsedForEffortCertificationGeneration

boolean hasBeenUsedForEffortCertificationGeneration(EffortCertificationReportDefinition reportDefinition)

determine whether the given report definition has been used to generate effort certification document

Parameters:

reportDefinition - the given report definition

Returns:

true if the given report definition has been used; otherwise, false

hasBeenUsedForEffortCertificationGeneration

boolean hasBeenUsedForEffortCertificationGeneration(String emplid,
                                                    EffortCertificationReport reportDefinition)

determine whether the given report definition has been used to generate effort certification documents for the given employee

Parameters:

emplid - the given employee id

reportDefinition - the given report definition

Returns:

true if the given report definition has been used for the employee; otherwise, false

hasPendingEffortCertification

boolean hasPendingEffortCertification(String emplid,
                                      EffortCertificationReportDefinition reportDefinition)

determine whether there is any pending/temporary effort certification waiting for the given report definition

Parameters:

reportDefinition - the given report definition

Returns:

true if there is any pending/temporary effort certification waiting for process; otherwise, false

hasApprovedEffortCertification

boolean hasApprovedEffortCertification(String emplid,
                                       EffortCertificationReportDefinition reportDefinition)

determine whether there is any approved effort certification for the given report definition and employee

Parameters:

emplid - the given employee id

reportDefinition - the given report definition

Returns:

true if there is any approved effort certification for the employee; otherwise, false