org.kuali.hr.time.approval.service
Interface TimeApproveService

All Known Implementing Classes:

TimeApproveServiceImpl

public interface TimeApproveService

Method Summary

boolean	doesApproverHavePrincipalsForCalendarGroup(Date asOfDate, String calGroup)
List<CalendarEntries>	getAllPayCalendarEntriesForApprover(String principalId, Date currentDate)
List<ApprovalTimeSummaryRow>	getApprovalSummaryRows(Date payBeginDate, Date payEndDate, String calGroup, List<TKPerson> principalIds, List<String> payCalendarLabels, CalendarEntries payCalendarEntries) Obtains a Map of Lists of ApprovalTimeSummaryRows.
SortedSet<String>	getApproverPayCalendarGroups(Date payBeginDate, Date payEndDate) Method to obtain all of the active Pay Calendar Group names for the current user / approver.
com.google.common.collect.Multimap<String,Long>	getDeptWorkAreasByDepts(Set<String> userDepts) Method to create a map of the depts and their associated work areas based on the given depts.
com.google.common.collect.Multimap<String,Long>	getDeptWorkAreasByWorkAreas(Set<Long> approverWorkAres) Method to create a map of the depts and their associated work areas based on the given approver work areas.
Map<String,BigDecimal>	getHoursToPayDayMap(String principalId, Date payEndDate, List<String> payCalendarLabels, List<TimeBlock> lstTimeBlocks, Long workArea, CalendarEntries payCalendarEntries, Calendar payCalendar, org.joda.time.DateTimeZone dateTimeZone, List<org.joda.time.Interval> dayIntervals)
List	getNotesForDocument(String documentNumber) Used to determine if there are notes on a document
Map<String,CalendarEntries>	getPayCalendarEntriesForApprover(String principalId, Date currentDate, String dept) Method to provide a mapping of PayCalendarGroupNames to PayCalendarEntries to allow for various starting points in Approval Tab Navigation.
Map<String,CalendarEntries>	getPayCalendarEntriesForDept(String dept, Date currentDate)
List<String>	getPayCalendarLabelsForApprovalTab(Date payBeginDate, Date payEndDate)
Map<String,TimesheetDocumentHeader>	getPrincipalDocumehtHeader(List<TKPerson> person, Date payBeginDate, Date payEndDate) Method to create a map that contains the principal's id and corresponding timesheet document header.
List<String>	getPrincipalIdsByDeptWorkAreaRolename(String roleName, String department, String workArea, Date payBeginDate, Date payEndDate, String calGroup) Method to get a list of principal ids based on the department work areas.
org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue	getRouteHeader(String documentId)
List<String>	getUniquePayGroups() Get a list of unique pay groups

Method Detail

getApprovalSummaryRows

List<ApprovalTimeSummaryRow> getApprovalSummaryRows(Date payBeginDate,
                                                    Date payEndDate,
                                                    String calGroup,
                                                    List<TKPerson> principalIds,
                                                    List<String> payCalendarLabels,
                                                    CalendarEntries payCalendarEntries)

Obtains a Map of Lists of ApprovalTimeSummaryRows. The Key to the map is the PayCalendar Group name.

Parameters:

payBeginDate -

payEndDate -

calGroup - Specify a calendar group to filter by.

Returns:

A Map> container.

getPayCalendarLabelsForApprovalTab

@Cacheable(value="KPME/Global",
           key="\'{PayCalendarLabelsForApprovalTab}\' + \'payBeginDate=\' + #p0 + \'|\' + \'payEndDate=\' + #p1")
List<String> getPayCalendarLabelsForApprovalTab(Date payBeginDate,
                                                          Date payEndDate)

getApproverPayCalendarGroups

SortedSet<String> getApproverPayCalendarGroups(Date payBeginDate,
                                               Date payEndDate)

Method to obtain all of the active Pay Calendar Group names for the current user / approver. We used SortedSet here since we only want unique values while keeping the order. Besides, we also need to get the first value as the default pay calendar group in some cases. There is not get() method in the Set interface.

Parameters:

payBeginDate -

payEndDate -

Returns:

getNotesForDocument

List getNotesForDocument(String documentNumber)

Used to determine if there are notes on a document

Parameters:

documentNumber -

Returns:

list of note objects

getHoursToPayDayMap

Map<String,BigDecimal> getHoursToPayDayMap(String principalId,
                                           Date payEndDate,
                                           List<String> payCalendarLabels,
                                           List<TimeBlock> lstTimeBlocks,
                                           Long workArea,
                                           CalendarEntries payCalendarEntries,
                                           Calendar payCalendar,
                                           org.joda.time.DateTimeZone dateTimeZone,
                                           List<org.joda.time.Interval> dayIntervals)

getPayCalendarEntriesForApprover

Map<String,CalendarEntries> getPayCalendarEntriesForApprover(String principalId,
                                                             Date currentDate,
                                                             String dept)

Method to provide a mapping of PayCalendarGroupNames to PayCalendarEntries to allow for various starting points in Approval Tab Navigation.

Parameters:

currentDate - The current date. This method will search for active assignments for this approver active as of this date, and 31 days prior to pull back PayCalendarEntries.

Returns:

A CalendarGroup Name to PayCalendarEntries mapping.

getAllPayCalendarEntriesForApprover

List<CalendarEntries> getAllPayCalendarEntriesForApprover(String principalId,
                                                          Date currentDate)

doesApproverHavePrincipalsForCalendarGroup

boolean doesApproverHavePrincipalsForCalendarGroup(Date asOfDate,
                                                   String calGroup)

getPayCalendarEntriesForDept

Map<String,CalendarEntries> getPayCalendarEntriesForDept(String dept,
                                                         Date currentDate)

getUniquePayGroups

List<String> getUniquePayGroups()

Get a list of unique pay groups

Returns:

getPrincipalIdsByDeptWorkAreaRolename

List<String> getPrincipalIdsByDeptWorkAreaRolename(String roleName,
                                                   String department,
                                                   String workArea,
                                                   Date payBeginDate,
                                                   Date payEndDate,
                                                   String calGroup)

Method to get a list of principal ids based on the department work areas.

Parameters:

roleName -

department -

workArea -

payEndDate -

calGroup -

Returns:

A list of the PrincipalIds

getPrincipalDocumehtHeader

Map<String,TimesheetDocumentHeader> getPrincipalDocumehtHeader(List<TKPerson> person,
                                                               Date payBeginDate,
                                                               Date payEndDate)

Method to create a map that contains the principal's id and corresponding timesheet document header.

Parameters:

payBeginDate -

payEndDate -

Returns:

A PrincipalId to TimesheetDocumentHeader mapping.

getDeptWorkAreasByWorkAreas

com.google.common.collect.Multimap<String,Long> getDeptWorkAreasByWorkAreas(Set<Long> approverWorkAres)

Method to create a map of the depts and their associated work areas based on the given approver work areas.

Parameters:

approverWorkAres -

Returns:

A Dept and Work Areas mapping.

getDeptWorkAreasByDepts

com.google.common.collect.Multimap<String,Long> getDeptWorkAreasByDepts(Set<String> userDepts)

Method to create a map of the depts and their associated work areas based on the given depts.

Parameters:

userDepts -

Returns:

A Dept and Work Areas mapping.

getRouteHeader

org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue getRouteHeader(String documentId)