org.kuali.kpme.tklm.api.time.clocklog

Interface ClockLogService

All Known Implementing Classes:

ClockLogServiceImpl

public interface ClockLogService

Method Summary

Methods

Modifier and Type	Method and Description
String	buildUnapprovedIPWarning(ClockLog cl) Build an unapproved IP address warning message for based on given ClockLog
void	deleteClockLogsForDocumentId(String documentId)
ClockLog	getClockLog(String tkClockLogId) Fetch clock log by id
ClockLog	getLastClockLog(String principalId) Fetch last clock log for principal id
ClockLog	getLastClockLog(String principalId, String clockAction) Fetch last clock log for principal id and clock action
ClockLog	getLastClockLog(String groupKeyCode, String principalId, String jobNumber, String workArea, String task, CalendarEntry calendarEntry) Fetch last clock log for group key code, principal id, assignment details, and calendar entry
List<String>	getUnapprovedIPWarning(List<TimeBlock> timeBlocks) Get warning messages for clock actions taken from unapproved IP address on given timesheet document
void	invalidIpCheck(String groupKeyCode, String dept, Long workArea, String principalId, Long jobNumber, String ipAddress, org.joda.time.LocalDate asOfDate, boolean missedPunch)
boolean	isClockLogCreatedByMissedPunch(String clockLogId) Determine if a clock log was created by Missed Punch document
ClockLog	processClockLog(String principalId, String documentId, org.joda.time.DateTime clockDateTime, Assignment assignment, CalendarEntry pe, String ip, org.joda.time.LocalDate asOfDate, String clockAction, boolean runRules) Process clock log created
ClockLog	processClockLog(String principalId, String documentId, org.joda.time.DateTime clockDateTime, Assignment assignment, CalendarEntry pe, String ip, org.joda.time.LocalDate asOfDate, String clockAction, boolean runRules, boolean missedPunch)
ClockLog	processClockLog(String principalId, String documentId, org.joda.time.DateTime clockDateTime, Assignment assignment, CalendarEntry pe, String ip, org.joda.time.LocalDate asOfDate, String clockAction, boolean runRules, String userPrincipalId)
ClockLog	processClockLog(String principalId, String documentId, org.joda.time.DateTime clockDateTime, Assignment assignment, CalendarEntry pe, String ip, org.joda.time.LocalDate asOfDate, String clockAction, boolean runRules, String userPrincipalId, boolean missedPunch)
ClockLog	saveClockLog(ClockLog clockLog) Save clock log
ClockLog	saveClockLog(ClockLog clockLog, boolean missedPunch)

Method Detail

invalidIpCheck

void invalidIpCheck(String groupKeyCode,
                  String dept,
                  Long workArea,
                  String principalId,
                  Long jobNumber,
                  String ipAddress,
                  org.joda.time.LocalDate asOfDate,
                  boolean missedPunch)
                    throws InvalidClockLogException

Throws:

InvalidClockLogException

saveClockLog

ClockLog saveClockLog(ClockLog clockLog,
                    boolean missedPunch)
                      throws InvalidClockLogException

Throws:

InvalidClockLogException

saveClockLog

ClockLog saveClockLog(ClockLog clockLog)
                      throws InvalidClockLogException

Save clock log

Parameters:

clockLog -

Throws:

InvalidClockLogException

processClockLog

@CacheEvict(value="http://kpme.kuali.org/core/Assignment",
            allEntries=true)
ClockLog processClockLog(String principalId,
                                  String documentId,
                                  org.joda.time.DateTime clockDateTime,
                                  Assignment assignment,
                                  CalendarEntry pe,
                                  String ip,
                                  org.joda.time.LocalDate asOfDate,
                                  String clockAction,
                                  boolean runRules,
                                  boolean missedPunch)
                         throws InvalidClockLogException

Throws:

InvalidClockLogException

processClockLog

@CacheEvict(value="http://kpme.kuali.org/core/Assignment",
            allEntries=true)
ClockLog processClockLog(String principalId,
                                  String documentId,
                                  org.joda.time.DateTime clockDateTime,
                                  Assignment assignment,
                                  CalendarEntry pe,
                                  String ip,
                                  org.joda.time.LocalDate asOfDate,
                                  String clockAction,
                                  boolean runRules)
                         throws InvalidClockLogException

Process clock log created

Parameters:

principalId -

documentId -

clockDateTime -

assignment -

pe -

ip -

asOfDate -

clockAction -

principalId -

Returns:

Throws:

InvalidClockLogException

processClockLog

@CacheEvict(value="http://kpme.kuali.org/core/Assignment",
            allEntries=true)
ClockLog processClockLog(String principalId,
                                  String documentId,
                                  org.joda.time.DateTime clockDateTime,
                                  Assignment assignment,
                                  CalendarEntry pe,
                                  String ip,
                                  org.joda.time.LocalDate asOfDate,
                                  String clockAction,
                                  boolean runRules,
                                  String userPrincipalId,
                                  boolean missedPunch)
                         throws InvalidClockLogException

Throws:

InvalidClockLogException

processClockLog

@CacheEvict(value="http://kpme.kuali.org/core/Assignment",
            allEntries=true)
ClockLog processClockLog(String principalId,
                                  String documentId,
                                  org.joda.time.DateTime clockDateTime,
                                  Assignment assignment,
                                  CalendarEntry pe,
                                  String ip,
                                  org.joda.time.LocalDate asOfDate,
                                  String clockAction,
                                  boolean runRules,
                                  String userPrincipalId)
                         throws InvalidClockLogException

Throws:

InvalidClockLogException

getLastClockLog

ClockLog getLastClockLog(String principalId)

Fetch last clock log for principal id

Parameters:

principalId -

Returns:

getLastClockLog

ClockLog getLastClockLog(String principalId,
                       String clockAction)

Fetch last clock log for principal id and clock action

Parameters:

principalId -

clockAction -

Returns:

getLastClockLog

ClockLog getLastClockLog(String groupKeyCode,
                       String principalId,
                       String jobNumber,
                       String workArea,
                       String task,
                       CalendarEntry calendarEntry)

Fetch last clock log for group key code, principal id, assignment details, and calendar entry

Parameters:

groupKeyCode -

principalId -

jobNumber -

workArea -

task -

task2 -

calendarEntry -

Returns:

getClockLog

ClockLog getClockLog(String tkClockLogId)

Fetch clock log by id

Parameters:

tkClockLogId -

Returns:

deleteClockLogsForDocumentId

@CacheEvict(value="http://kpme.kuali.org/core/Assignment",
            allEntries=true)
void deleteClockLogsForDocumentId(String documentId)

getUnapprovedIPWarning

List<String> getUnapprovedIPWarning(List<TimeBlock> timeBlocks)

Get warning messages for clock actions taken from unapproved IP address on given timesheet document

Parameters:

timeBlocks -

Returns:

List

buildUnapprovedIPWarning

String buildUnapprovedIPWarning(ClockLog cl)

Build an unapproved IP address warning message for based on given ClockLog

Parameters:

cl -

Returns:

isClockLogCreatedByMissedPunch

boolean isClockLogCreatedByMissedPunch(String clockLogId)

Determine if a clock log was created by Missed Punch document

Parameters:

clockLogId -

Returns: