org.kuali.hr.time.timeblock.service
Interface TimeBlockService

All Known Implementing Classes:
TimeBlockServiceImpl

public interface TimeBlockService


Method Summary
 List<TimeBlock> buildTimeBlocks(Assignment assignment, String earnCode, TimesheetDocument timesheetDocument, Timestamp beginTimestamp, Timestamp endTimestamp, BigDecimal hours, BigDecimal amount, Boolean isClockLogCreated, Boolean isLunchDeleted, String userPrincipalId)
          Build a TimeBlock with the given criteria
 List<TimeBlock> buildTimeBlocksSpanDates(Assignment assignment, String earnCode, TimesheetDocument timesheetDocument, Timestamp beginTimestamp, Timestamp endTimestamp, BigDecimal hours, BigDecimal amount, Boolean isClockLogCreated, Boolean isLunchDeleted, String spanningWeeks, String userPrincipalId)
          Build a List of TimeBlocks over a span of multiple days
 TimeBlock createTimeBlock(TimesheetDocument timesheetDocument, Timestamp beginTime, Timestamp endTime, Assignment assignment, String earnCode, BigDecimal hours, BigDecimal amount, Boolean isClockLogCreated, Boolean isLunchDeleted, String userPrincipalId)
          Create a TimeBlock for the given criteria
 List<TimeBlockHistory> createTimeBlockHistories(TimeBlock tb, String actionHistory)
           
 void deleteLunchDeduction(String tkTimeHourDetailId)
           
 void deleteTimeBlock(TimeBlock timeBlock)
          Delete a given TimeBlock
 void deleteTimeBlocksAssociatedWithDocumentId(String documentId)
           
 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
 List<TimeBlock> getTimeBlocks(String documentId)
          Get the List of TimeBlock of a given document id
 List<TimeBlock> getTimeBlocksForAssignment(Assignment assign)
          Get the List of TimeBlock of a given Assignment
 List<TimeBlock> getTimeBlocksForClockLogBeginId(String tkClockLogId)
           
 List<TimeBlock> getTimeBlocksForClockLogEndId(String tkClockLogId)
           
 List<TimeBlock> getTimeBlocksWithEarnCode(String earnCode, Date effDate)
           
 Boolean isTimeBlockEditable(TimeBlock tb)
           
 void resetTimeHourDetail(List<TimeBlock> origTimeBlocks)
          Reset the TimeHourDetail object associated with the TimeBlock object on a List of TimeBlocks
 void saveTimeBlocks(List<TimeBlock> tbList)
          Save a list of new TimeBlocks
 void saveTimeBlocks(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
 void updateTimeBlock(TimeBlock tb)
           
 

Method Detail

getTimeBlock

TimeBlock getTimeBlock(String timeBlockId)
Fetch a TimeBlock by a given ID

Parameters:
timeBlockId -
Returns:

deleteTimeBlock

void deleteTimeBlock(TimeBlock timeBlock)
Delete a given TimeBlock

Parameters:
timeBlock -

buildTimeBlocks

List<TimeBlock> buildTimeBlocks(Assignment assignment,
                                String earnCode,
                                TimesheetDocument timesheetDocument,
                                Timestamp beginTimestamp,
                                Timestamp endTimestamp,
                                BigDecimal hours,
                                BigDecimal amount,
                                Boolean isClockLogCreated,
                                Boolean isLunchDeleted,
                                String userPrincipalId)
Build a TimeBlock with the given criteria

Parameters:
assignment -
earnCode -
timesheetDocument -
beginTimestamp -
endTimestamp -
hours -
amount -
isClockLogCreated -
isLunchDeleted -
Returns:

saveTimeBlocks

void saveTimeBlocks(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

void saveTimeBlocks(List<TimeBlock> tbList)
Save a list of new TimeBlocks

Parameters:
tbList -

resetTimeHourDetail

void resetTimeHourDetail(List<TimeBlock> origTimeBlocks)
Reset the TimeHourDetail object associated with the TimeBlock object on a List of TimeBlocks

Parameters:
origTimeBlocks -

getTimeBlocks

List<TimeBlock> getTimeBlocks(String documentId)
Get the List of TimeBlock of a given document id

Parameters:
documentId -
Returns:

getTimeBlocksForAssignment

List<TimeBlock> getTimeBlocksForAssignment(Assignment assign)
Get the List of TimeBlock of a given Assignment

Parameters:
assign -
Returns:
List

buildTimeBlocksSpanDates

List<TimeBlock> buildTimeBlocksSpanDates(Assignment assignment,
                                         String earnCode,
                                         TimesheetDocument timesheetDocument,
                                         Timestamp beginTimestamp,
                                         Timestamp endTimestamp,
                                         BigDecimal hours,
                                         BigDecimal amount,
                                         Boolean isClockLogCreated,
                                         Boolean isLunchDeleted,
                                         String spanningWeeks,
                                         String userPrincipalId)
Build a List of TimeBlocks over a span of multiple days

Parameters:
assignment -
earnCode -
timesheetDocument -
beginTimestamp -
endTimestamp -
hours -
amount -
isClockLogCreated -
isLunchDeleted -
spanningWeeks -
Returns:

createTimeBlock

TimeBlock createTimeBlock(TimesheetDocument timesheetDocument,
                          Timestamp beginTime,
                          Timestamp endTime,
                          Assignment assignment,
                          String earnCode,
                          BigDecimal hours,
                          BigDecimal amount,
                          Boolean isClockLogCreated,
                          Boolean isLunchDeleted,
                          String userPrincipalId)
Create a TimeBlock for the given criteria

Parameters:
timesheetDocument -
beginTime -
endTime -
assignment -
earnCode -
hours -
amount -
isClockLogCreated -
isLunchDeleted -
Returns:

deleteTimeBlocksAssociatedWithDocumentId

void deleteTimeBlocksAssociatedWithDocumentId(String documentId)

isTimeBlockEditable

Boolean isTimeBlockEditable(TimeBlock tb)

getTimeBlocksForClockLogEndId

List<TimeBlock> getTimeBlocksForClockLogEndId(String tkClockLogId)

getTimeBlocksForClockLogBeginId

List<TimeBlock> getTimeBlocksForClockLogBeginId(String tkClockLogId)

getLatestEndTimestampForEarnCode

List<TimeBlock> getLatestEndTimestampForEarnCode(String earnCode)

getOvernightTimeBlocks

List<TimeBlock> getOvernightTimeBlocks(String clockLogEndId)
Get overnight timeblocks by the clock log begin id

Parameters:
clockLogBeginId -
Returns:

updateTimeBlock

void updateTimeBlock(TimeBlock tb)

createTimeBlockHistories

List<TimeBlockHistory> createTimeBlockHistories(TimeBlock tb,
                                                String actionHistory)

deleteLunchDeduction

void deleteLunchDeduction(String tkTimeHourDetailId)

getTimeBlocksWithEarnCode

List<TimeBlock> getTimeBlocksWithEarnCode(String earnCode,
                                          Date effDate)


Copyright © 2004-2013 The Kuali Foundation. All Rights Reserved.