org.kuali.kpme.tklm.api.time.timeblock

Interface TimeBlockService

All Known Implementing Classes:

TimeBlockServiceImpl

public interface TimeBlockService

Method Summary

Methods

Modifier and Type	Method and Description
List<TimeBlock>	applyHolidayPremiumEarnCode(String principalId, List<Assignment> timeAssignments, List<TimeBlock> appliedTimeBlocks)
List<TimeBlock>	buildTimeBlocks(String principalId, CalendarEntry calendarEntry, Assignment assignment, String earnCode, String documentId, org.joda.time.DateTime beginDateTime, org.joda.time.DateTime endDateTime, BigDecimal hours, BigDecimal amount, Boolean getClockLogCreated, Boolean getLunchDeleted, String userPrincipalId, String clockLogBeginId, String clockLogEndId) Build a TimeBlock with the given criteria
List<TimeBlock>	buildTimeBlocksSpanDates(String principalId, CalendarEntry calendarEntry, Assignment assignment, String earnCode, String documentId, org.joda.time.DateTime beginDateTime, org.joda.time.DateTime endDateTime, BigDecimal hours, BigDecimal amount, Boolean clockLogCreated, Boolean lunchDeleted, String userPrincipalId, String clockLogBeginId, String clockLogEndId) Build a List of TimeBlocks over a span of multiple days
TimeBlock	createTimeBlock(String principalId, String documentId, org.joda.time.DateTime beginDateTime, org.joda.time.DateTime endDateTime, Assignment assignment, String earnCode, BigDecimal hours, BigDecimal amount, Boolean clockLogCreated, Boolean lunchDeleted, String userPrincipalId) Create a TimeBlock for the given criteria
void	deleteLunchDeduction(String tkTimeHourDetailId)
void	deleteTimeBlock(TimeBlock timeBlock) Delete a given TimeBlock
void	deleteTimeBlockAndHandleMissedPunch(TimeBlock timeBlock, boolean ignoreMissedPunch)
void	deleteTimeBlocksAssociatedWithDocumentId(String documentId)
List<TimeBlock>	getIntersectingTimeBlocks(String principalId, org.joda.time.DateTime startTime, org.joda.time.DateTime endTime)
List<TimeBlock>	getLatestEndTimestampForEarnCode(String earnCode)
List<TimeBlock>	getOvernightTimeBlocks(String clockLogEndId) Get overnight timeblocks by the clock log begin id
TimeBlock	getTimeBlock(String timeBlockId) Fetch a TimeBlock by a given ID
Boolean	getTimeBlockEditable(TimeBlock tb)
List<TimeBlock>	getTimeBlocks(String documentId) Get the List of TimeBlock of a given document id
List<TimeBlock>	getTimeBlocksForClockLogBeginId(String tkClockLogId)
List<TimeBlock>	getTimeBlocksForClockLogEndId(String tkClockLogId)
List<TimeBlock>	getTimeBlocksWithMissedPunchInfo(String documentId)
boolean	isOvernightTimeBlock(String clockLogEndId)
List<TimeBlock>	resetTimeHourDetail(List<TimeBlock> origTimeBlocks) Reset the TimeHourDetail object associated with the TimeBlock object on a List of TimeBlocks
List<TimeBlock>	saveOrUpdateTimeBlocks(List<TimeBlock> oldTimeBlocks, List<TimeBlock> newTimeBlocks, String userPrincipalId) Save a list of new TimeBlocks does a comparison for the old versus the new and only saves changed/new/deleted TimeBlocks
List<TimeBlock>	saveTimeBlocks(List<TimeBlock> tbList) Save a list of new TimeBlocks
TimeBlock	updateTimeBlock(TimeBlock tb)

Method Detail

getTimeBlock

@Cacheable(value="http://kpme.kuali.org/tklm/TimeBlock",
           key="\'{getTimeBlock}\' + \'timeBlockId=\' + #p0")
TimeBlock getTimeBlock(String timeBlockId)

Fetch a TimeBlock by a given ID

Parameters:

timeBlockId -

Returns:

deleteTimeBlock

@Caching(evict={@CacheEvict(value="http://kpme.kuali.org/tklm/TimeBlock",allEntries=true),@CacheEvict(value="http://kpme.kuali.org/core/CalendarBlockPermission",key="\'{time}\' + #p0.tkTimeBlockId")})
void deleteTimeBlock(TimeBlock timeBlock)

Delete a given TimeBlock

Parameters:

timeBlock -

buildTimeBlocks

List<TimeBlock> buildTimeBlocks(String principalId,
                              CalendarEntry calendarEntry,
                              Assignment assignment,
                              String earnCode,
                              String documentId,
                              org.joda.time.DateTime beginDateTime,
                              org.joda.time.DateTime endDateTime,
                              BigDecimal hours,
                              BigDecimal amount,
                              Boolean getClockLogCreated,
                              Boolean getLunchDeleted,
                              String userPrincipalId,
                              String clockLogBeginId,
                              String clockLogEndId)

Build a TimeBlock with the given criteria

Parameters:

principalId -

calendarEntry -

assignment -

earnCode -

documentId -

beginDateTime -

endDateTime -

hours -

amount -

getClockLogCreated -

getLunchDeleted -

clockLogBeginId -

clockLogEndId -

Returns:

saveOrUpdateTimeBlocks

@Caching(evict=@CacheEvict(value="http://kpme.kuali.org/tklm/TimeBlock",allEntries=true))
List<TimeBlock> saveOrUpdateTimeBlocks(List<TimeBlock> oldTimeBlocks,
                                                        List<TimeBlock> newTimeBlocks,
                                                        String userPrincipalId)

Save a list of new TimeBlocks does a comparison for the old versus the new and only saves changed/new/deleted TimeBlocks

Parameters:

oldTimeBlocks -

newTimeBlocks -

saveTimeBlocks

@Caching(evict=@CacheEvict(value="http://kpme.kuali.org/tklm/TimeBlock",allEntries=true))
List<TimeBlock> saveTimeBlocks(List<TimeBlock> tbList)

Save a list of new TimeBlocks

Parameters:

tbList -

deleteTimeBlockAndHandleMissedPunch

void deleteTimeBlockAndHandleMissedPunch(TimeBlock timeBlock,
                                       boolean ignoreMissedPunch)

resetTimeHourDetail

List<TimeBlock> resetTimeHourDetail(List<TimeBlock> origTimeBlocks)

Reset the TimeHourDetail object associated with the TimeBlock object on a List of TimeBlocks

Parameters:

origTimeBlocks -

getTimeBlocks

@Cacheable(value="http://kpme.kuali.org/tklm/TimeBlock",
           key="\'{getTimeBlocks}\' + \'documentId=\' + #p0")
List<TimeBlock> getTimeBlocks(String documentId)

Get the List of TimeBlock of a given document id

Parameters:

documentId -

Returns:

getTimeBlocksWithMissedPunchInfo

@Cacheable(value="http://kpme.kuali.org/tklm/TimeBlock",
           key="\'{getTimeBlocksWithMissedPunchInfo}\' + \'documentId=\' + #p0")
List<TimeBlock> getTimeBlocksWithMissedPunchInfo(String documentId)

buildTimeBlocksSpanDates

List<TimeBlock> buildTimeBlocksSpanDates(String principalId,
                                       CalendarEntry calendarEntry,
                                       Assignment assignment,
                                       String earnCode,
                                       String documentId,
                                       org.joda.time.DateTime beginDateTime,
                                       org.joda.time.DateTime endDateTime,
                                       BigDecimal hours,
                                       BigDecimal amount,
                                       Boolean clockLogCreated,
                                       Boolean lunchDeleted,
                                       String userPrincipalId,
                                       String clockLogBeginId,
                                       String clockLogEndId)

Build a List of TimeBlocks over a span of multiple days

Parameters:

principalId -

calendarEntry -

assignment -

earnCode -

documentId -

beginDateTime -

endDateTime -

hours -

amount -

clockLogCreated -

lunchDeleted -

Returns:

createTimeBlock

TimeBlock createTimeBlock(String principalId,
                        String documentId,
                        org.joda.time.DateTime beginDateTime,
                        org.joda.time.DateTime endDateTime,
                        Assignment assignment,
                        String earnCode,
                        BigDecimal hours,
                        BigDecimal amount,
                        Boolean clockLogCreated,
                        Boolean lunchDeleted,
                        String userPrincipalId)

Create a TimeBlock for the given criteria

Parameters:

principalId -

documentId -

beginDateTime -

endDateTime -

assignment -

earnCode -

hours -

amount -

clockLogCreated -

lunchDeleted -

Returns:

deleteTimeBlocksAssociatedWithDocumentId

@Caching(evict={@CacheEvict(value="http://kpme.kuali.org/tklm/TimeBlock",allEntries=true),@CacheEvict(value="http://kpme.kuali.org/core/CalendarBlockPermission",allEntries=true)})
void deleteTimeBlocksAssociatedWithDocumentId(String documentId)

getTimeBlockEditable

Boolean getTimeBlockEditable(TimeBlock tb)

getTimeBlocksForClockLogEndId

@Cacheable(value="http://kpme.kuali.org/tklm/TimeBlock",
           key="\'{getTimeBlocksForClockLogEndId}\' + \'tkClockLogId=\' + #p0")
List<TimeBlock> getTimeBlocksForClockLogEndId(String tkClockLogId)

getTimeBlocksForClockLogBeginId

@Cacheable(value="http://kpme.kuali.org/tklm/TimeBlock",
           key="\'{getTimeBlocksForClockLogBeginId}\' + \'tkClockLogId=\' + #p0")
List<TimeBlock> getTimeBlocksForClockLogBeginId(String tkClockLogId)

getLatestEndTimestampForEarnCode

@Cacheable(value="http://kpme.kuali.org/tklm/TimeBlock",
           key="\'{getLatestEndTimestampForEarnCode}\' + \'earnCode=\' + #p0")
List<TimeBlock> getLatestEndTimestampForEarnCode(String earnCode)

getOvernightTimeBlocks

@Cacheable(value="http://kpme.kuali.org/tklm/TimeBlock",
           key="\'{getOvernightTimeBlocks}\' + \'clockLogEndId=\' + #p0")
List<TimeBlock> getOvernightTimeBlocks(String clockLogEndId)

Get overnight timeblocks by the clock log begin id

Parameters:

clockLogEndId -

Returns:

isOvernightTimeBlock

@Cacheable(value="http://kpme.kuali.org/tklm/TimeBlock",
           key="\'{isOvernightTimeBlock}\' + \'clockLogEndId=\' + #p0")
boolean isOvernightTimeBlock(String clockLogEndId)

updateTimeBlock

@Caching(evict={@CacheEvict(value="http://kpme.kuali.org/tklm/TimeBlock",allEntries=true),@CacheEvict(value="http://kpme.kuali.org/core/CalendarBlockPermission",key="\'{time}\' + #p0.tkTimeBlockId")})
TimeBlock updateTimeBlock(TimeBlock tb)

deleteLunchDeduction

@Caching(evict=@CacheEvict(value="http://kpme.kuali.org/tklm/TimeBlock",allEntries=true))
void deleteLunchDeduction(String tkTimeHourDetailId)

applyHolidayPremiumEarnCode

List<TimeBlock> applyHolidayPremiumEarnCode(String principalId,
                                          List<Assignment> timeAssignments,
                                          List<TimeBlock> appliedTimeBlocks)

getIntersectingTimeBlocks

List<TimeBlock> getIntersectingTimeBlocks(String principalId,
                                        org.joda.time.DateTime startTime,
                                        org.joda.time.DateTime endTime)