org.kuali.kpme.tklm.time.timesheet.service
Interface TimesheetService

All Known Implementing Classes:

TimesheetServiceImpl

public interface TimesheetService

Method Summary

void	approveTimesheet(String principalId, TimesheetDocument timesheetDocument)
void	approveTimesheet(String principalId, TimesheetDocument timesheetDocument, String action)
void	deleteTimesheet(String documentId) Delete a timesheet(used for testing only)
void	disapproveTimesheet(String principalId, TimesheetDocument timesheetDocument)
List<EarnCode>	getEarnCodesForTime(Assignment assignment, org.joda.time.LocalDate asOfDate) Previously in EarnCodeService
List<EarnCode>	getEarnCodesForTime(Assignment a, org.joda.time.LocalDate asOfDate, boolean includeRegularEarnCode) Fetch a list of earn codes for Time usage, for a particular assignment as of a particular date
List<TimeBlock>	getPrevDocumentTimeBlocks(String principalId, org.joda.time.DateTime payBeginDate) Fetch TimeBlocks for previous pay periods
TimesheetDocument	getTimesheetDocument(String documentId) For a given document ID, return a fully populated time sheet document.
boolean	isReadyToApprove(TimesheetDocument document)
boolean	isSynchronousUser() Is user a Clock in/out person or do they manually enter TimeBlocks
void	loadHolidaysOnTimesheet(TimesheetDocument timesheetDocument, String principalId, org.joda.time.LocalDate beginDate, org.joda.time.LocalDate endDate) Load holidays on given timesheet
TimesheetDocument	openTimesheetDocument(String principalId, CalendarEntry payCalendarDates) Opens the timesheet document for the user at the given payEndDate provided.
void	resetTimeBlock(List<TimeBlock> timeBlock, org.joda.time.LocalDate asOfDate)
void	routeTimesheet(String principalId, TimesheetDocument timesheetDocument) Route the given timesheet
void	routeTimesheet(String principalId, TimesheetDocument timesheetDocument, String action)

Method Detail

openTimesheetDocument

TimesheetDocument openTimesheetDocument(String principalId,
                                        CalendarEntry payCalendarDates)
                                        throws org.kuali.rice.kew.api.exception.WorkflowException

Opens the timesheet document for the user at the given payEndDate provided. If the timesheet does not exist, it is created.

Parameters:

principalId -

Returns:

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

routeTimesheet

void routeTimesheet(String principalId,
                    TimesheetDocument timesheetDocument)

Route the given timesheet

Parameters:

principalId -

timesheetDocument -

approveTimesheet

void approveTimesheet(String principalId,
                      TimesheetDocument timesheetDocument)

disapproveTimesheet

void disapproveTimesheet(String principalId,
                         TimesheetDocument timesheetDocument)

getTimesheetDocument

TimesheetDocument getTimesheetDocument(String documentId)

For a given document ID, return a fully populated time sheet document. Fully populated means: TimeBlocks, Jobs, Assignments

Parameters:

documentId -

Returns:

isSynchronousUser

boolean isSynchronousUser()

Is user a Clock in/out person or do they manually enter TimeBlocks

Returns:

getPrevDocumentTimeBlocks

List<TimeBlock> getPrevDocumentTimeBlocks(String principalId,
                                          org.joda.time.DateTime payBeginDate)

Fetch TimeBlocks for previous pay periods

Parameters:

principalId -

payBeginDate -

Returns:

loadHolidaysOnTimesheet

void loadHolidaysOnTimesheet(TimesheetDocument timesheetDocument,
                             String principalId,
                             org.joda.time.LocalDate beginDate,
                             org.joda.time.LocalDate endDate)

Load holidays on given timesheet

Parameters:

timesheetDocument -

principalId -

beginDate -

endDate -

deleteTimesheet

void deleteTimesheet(String documentId)

Delete a timesheet(used for testing only)

Parameters:

documentId -

resetTimeBlock

void resetTimeBlock(List<TimeBlock> timeBlock,
                    org.joda.time.LocalDate asOfDate)

approveTimesheet

void approveTimesheet(String principalId,
                      TimesheetDocument timesheetDocument,
                      String action)

routeTimesheet

void routeTimesheet(String principalId,
                    TimesheetDocument timesheetDocument,
                    String action)

isReadyToApprove

boolean isReadyToApprove(TimesheetDocument document)

getEarnCodesForTime

@Cacheable(value="http://kpme.kuali.org/core/EarnCode",
           key="\'{getEarnCodesForTime}\' + \'principalId=\' + T(org.kuali.kpme.tklm.time.util.TkContext).getPrincipalId() + \'|\' + \'targetId=\' + T(org.kuali.kpme.tklm.time.util.TkContext).getTargetPrincipalId() + \'|\' + \'a=\' + #p0.getTkAssignmentId() + \'|\' + \'asOfDate=\' + #p1 + \'|\' + \'includeRegularEarnCode=\' + false")
List<EarnCode> getEarnCodesForTime(Assignment assignment,
                                             org.joda.time.LocalDate asOfDate)

Previously in EarnCodeService

Parameters:

assignment -

asOfDate -

Returns:

getEarnCodesForTime

@Cacheable(value="http://kpme.kuali.org/core/EarnCode",
           key="\'{getEarnCodesForTime}\' + \'principalId=\' + T(org.kuali.kpme.tklm.time.util.TkContext).getPrincipalId() + \'|\' + \'targetId=\' + T(org.kuali.kpme.tklm.time.util.TkContext).getTargetPrincipalId() + \'|\' + \'a=\' + #p0.getTkAssignmentId() + \'|\' + \'asOfDate=\' + #p1 + \'|\' + \'includeRegularEarnCode=\' + #p2")
List<EarnCode> getEarnCodesForTime(Assignment a,
                                             org.joda.time.LocalDate asOfDate,
                                             boolean includeRegularEarnCode)

Fetch a list of earn codes for Time usage, for a particular assignment as of a particular date

Parameters:

a -

asOfDate -

Returns: