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

All Superinterfaces:

CalendarBlockContract

All Known Subinterfaces:

TimeBlockHistoryContract

All Known Implementing Classes:

TimeBlock, TimeBlockHistory

public interface TimeBlockContract
extends CalendarBlockContract

TimeBlockContract interface

Method Summary

String	getActualBeginTimeString() The actual begin time string associated with the TimeBlock
String	getActualEndTimeString() The actual end time string associated with the TimeBlock
BigDecimal	getAmount() The amount associated with the TimeBlock
String	getAssignmentDescription() The assignment description associated with the TimeBlock
String	getAssignmentKey() The assignment key associated with the TimeBlock
Date	getBeginDate() The beginTimestamp (Date) associated with the TimeBlock
org.joda.time.DateTime	getBeginDateTime() The beginTimestamp (Datetime) associated with the TimeBlock
Time	getBeginTime() The beginTimestamp (Time) associated with the TimeBlock
org.joda.time.DateTime	getBeginTimeDisplay() The Timeblock begin time to display with the user's Timezone taken into account and applied to this DateTime object.
Date	getBeginTimeDisplayDate() The Timeblock begin time (Date) associated with the TimeBlock
String	getBeginTimeDisplayDateOnlyString() The date portion of the Timeblock begin time associated with the TimeBlock
String	getBeginTimeDisplayTimeOnlyString() The time portion of the Timeblock begin time associated with the TimeBlock
String	getClockLogBeginId() The clock log begin id associated with the TimeBlock
Boolean	getClockLogCreated() TODO: Make sure this comment is right The flag that indicates if a clock log has been created or not.
String	getClockLogEndId() The clock log end id associated with the TimeBlock
Boolean	getDeleteable() Indicates if this user has a permission to delete this time block
String	getEarnCodeType() The earn code type associated with the TimeBlock
Boolean	getEditable() Indicates if the user has permission to edit/delete the TimeBlock
Date	getEndDate() The endTimestamp (Date) associated with the TimeBlock
org.joda.time.DateTime	getEndDateTime() The endTimestamp (DateTime) associated with the TimeBlock
Time	getEndTime() The endTimestamp (Time) associated with the TimeBlock
org.joda.time.DateTime	getEndTimeDisplay() The Timeblock end time to display with the user's Timezone taken into account and applied to this DateTime object.
Date	getEndTimeDisplayDate() The Timeblock end time (Date) associated with the TimeBlock
String	getEndTimeDisplayDateOnlyString() The date portion of the Timeblock end time associated with the TimeBlock
String	getEndTimeDisplayTimeOnlyString() The time portion of the Timeblock end time associated with the TimeBlock
Date	getEndTimestamp() The endTimestamp associated with the TimeBlock
BigDecimal	getHours() The hours associated with the TimeBlock
String	getHrCalendarBlockId() The id of the CalendarBlock object associated with the TimeBlock
Boolean	getOvertimeEditable() Indicates if overtime earn code can be edited
String	getOvertimePref() TODO: Put a better comment The overtimePref associated with the TimeBlock
String	getPrincipalId() The principalId associated with the TimeBlock
Boolean	getPushBackward() The flag that indicates if the TimeBlock will be pushed back or not
Boolean	getTimeBlockEditable() Indicates if this user has a permission to edit this time block
List<? extends TimeBlockHistoryContract>	getTimeBlockHistories() The list of TimeBlockHistory objects associated with the TimeBlock
List<? extends TimeHourDetailContract>	getTimeHourDetails() The list of TimeHourDetail objects associated with the TimeBlock
TimesheetDocumentHeaderContract	getTimesheetDocumentHeader() The TimesheetDocumentHeader object associated with the TimeBlock
Timestamp	getTimestamp() The timestamp associated with the TimeBlock
String	getTkTimeBlockId() The primary key of a TimeBlock entry saved in a database
org.kuali.rice.kim.api.identity.Person	getUser() The Person object associated with the TimeBlock
String	getUserPrincipalId() The userPrincipalId associated with the TimeBlock
boolean	isLunchDeleted() TODO: Make sure this comment is right The flag that indicates if lunch hour is deleted

Methods inherited from interface org.kuali.kpme.core.api.block.CalendarBlockContract

getBeginTimestamp, getConcreteBlockId, getConcreteBlockType, getDocumentId, getEarnCode, getJobNumber, getLunchDeleted, getTask, getWorkArea, setAmount, setBeginTimestamp, setConcreteBlockId, setConcreteBlockType, setDocumentId, setEarnCode, setEndTimestamp, setHours, setHrCalendarBlockId, setJobNumber, setLunchDeleted, setOvertimePref, setPrincipalId, setTask, setTimestamp, setWorkArea

Method Detail

getBeginDate

Date getBeginDate()

The beginTimestamp (Date) associated with the TimeBlock

beginTimestamp wrapped in Date object of a TimeBlock

Returns:

new Date(beginTimestamp.getTime())

getBeginTime

Time getBeginTime()

The beginTimestamp (Time) associated with the TimeBlock

beginTimestamp wrapped in Time object of a TimeBlock

Returns:

new Time(beginTimestamp.getTime())

getBeginDateTime

org.joda.time.DateTime getBeginDateTime()

The beginTimestamp (Datetime) associated with the TimeBlock

beginTimestamp wrapped in DateTime object of a TimeBlock

Returns:

new DateTime(beginTimestamp)

getEndTimestamp

Date getEndTimestamp()

The endTimestamp associated with the TimeBlock

endTimestamp of a TimeBlock

Specified by:

getEndTimestamp in interface CalendarBlockContract

Returns:

endTimestamp for TimeBlock

getEndDate

Date getEndDate()

The endTimestamp (Date) associated with the TimeBlock

endTimestamp wrapped in Date object of a TimeBlock

Returns:

new Date(endTimestamp.getTime())

getEndTime

Time getEndTime()

The endTimestamp (Time) associated with the TimeBlock

endTimestamp wrapped in Time object of a TimeBlock

Returns:

new Time(endTimestamp.getTime())

getEndDateTime

org.joda.time.DateTime getEndDateTime()

The endTimestamp (DateTime) associated with the TimeBlock

endTimestamp wrapped in DateTime object of a TimeBlock

Returns:

new DateTime(endTimestamp)

getClockLogCreated

Boolean getClockLogCreated()

TODO: Make sure this comment is right The flag that indicates if a clock log has been created or not.

clockLogCreated flag of a ShiftDifferentialRule

Returns:

Y if created, N if not

getHours

BigDecimal getHours()

The hours associated with the TimeBlock

hours of a TimeBlock

Specified by:

getHours in interface CalendarBlockContract

Returns:

hours for TimeBlock

getAmount

BigDecimal getAmount()

The amount associated with the TimeBlock

amount of a TimeBlock

Specified by:

getAmount in interface CalendarBlockContract

Returns:

amount for TimeBlock

getUserPrincipalId

String getUserPrincipalId()

The userPrincipalId associated with the TimeBlock

userPrincipalId of a TimeBlock

Returns:

userPrincipalId for TimeBlock

getTimestamp

Timestamp getTimestamp()

The timestamp associated with the TimeBlock

timestamp of a TimeBlock

Specified by:

getTimestamp in interface CalendarBlockContract

Returns:

timestamp for TimeBlock

getTkTimeBlockId

String getTkTimeBlockId()

The primary key of a TimeBlock entry saved in a database

tkTimeBlockId of a TimeBlock

Returns:

tkTimeBlockId for TimeBlock

getTimeHourDetails

List<? extends TimeHourDetailContract> getTimeHourDetails()

The list of TimeHourDetail objects associated with the TimeBlock

timeHourDetails of a TimeBlock

Returns:

timeHourDetails for TimeBlock

getPushBackward

Boolean getPushBackward()

The flag that indicates if the TimeBlock will be pushed back or not

A timeblock will be pushed back if the timeblock is still within the previous interval.

Returns:

Y if pushed back, N if not

getBeginTimeDisplay

org.joda.time.DateTime getBeginTimeDisplay()

The Timeblock begin time to display with the user's Timezone taken into account and applied to this DateTime object.

Use this call for all GUI/Display related rendering of the END timestamp of the given time block. Timeblocks require pre-processing before there will be a non-null return value here.

Returns:

beginTimeDisplay for TimeBlock

getBeginTimeDisplayDate

Date getBeginTimeDisplayDate()

The Timeblock begin time (Date) associated with the TimeBlock

Returns:

Date object representing getBeginTimeDisplay()

getBeginTimeDisplayDateOnlyString

String getBeginTimeDisplayDateOnlyString()

The date portion of the Timeblock begin time associated with the TimeBlock

Returns:

a string representing the getBeginTimeDisplay() in MM/dd/yyyy format

getBeginTimeDisplayTimeOnlyString

String getBeginTimeDisplayTimeOnlyString()

The time portion of the Timeblock begin time associated with the TimeBlock

Returns:

a string representing getBeginTimeDisplay() in hh:mm aa format

getEndTimeDisplayDateOnlyString

String getEndTimeDisplayDateOnlyString()

The date portion of the Timeblock end time associated with the TimeBlock

Returns:

a string representing getEndTimeDisplay() in MM/dd/yyyy format

getEndTimeDisplayTimeOnlyString

String getEndTimeDisplayTimeOnlyString()

The time portion of the Timeblock end time associated with the TimeBlock

Returns:

a string representing the getEndTimeDisplay() in hh:mm aa format

getEndTimeDisplay

org.joda.time.DateTime getEndTimeDisplay()

The Timeblock end time to display with the user's Timezone taken into account and applied to this DateTime object.

Use this call for all GUI/Display related rendering of the END timestamp of the given time block. Timeblocks require pre-processing before there will be a non-null return value here.

Returns:

endTimeDisplay for TimeBlock

getEndTimeDisplayDate

Date getEndTimeDisplayDate()

The Timeblock end time (Date) associated with the TimeBlock

Returns:

Date object representing getEndTimeDisplay()

getTimesheetDocumentHeader

TimesheetDocumentHeaderContract getTimesheetDocumentHeader()

The TimesheetDocumentHeader object associated with the TimeBlock

timesheetDocumentHeader of a TimeBlock

Returns:

timesheetDocumentHeader for TimeBlock

getTimeBlockHistories

List<? extends TimeBlockHistoryContract> getTimeBlockHistories()

The list of TimeBlockHistory objects associated with the TimeBlock

timeBlockHistories of a TimeBlock

Returns:

timeBlockHistories for TimeBlock

getClockLogBeginId

String getClockLogBeginId()

The clock log begin id associated with the TimeBlock

clockLogBeginId of a TimeBlock

Returns:

clockLogBeginId for TimeBlock

getClockLogEndId

String getClockLogEndId()

The clock log end id associated with the TimeBlock

clockLogEndId of a TimeBlock

Returns:

clockLogEndId for TimeBlock

getAssignmentKey

String getAssignmentKey()

The assignment key associated with the TimeBlock

assignmentKey of a TimeBlock

Returns:

assignmentKey for TimeBlock

getAssignmentDescription

String getAssignmentDescription()

The assignment description associated with the TimeBlock

assignment description of a TimeBlock

Returns:

assignment description for TimeBlock

getEarnCodeType

String getEarnCodeType()

The earn code type associated with the TimeBlock

earnCodeType of a TimeBlock

Returns:

earnCodeType for TimeBlock

getEditable

Boolean getEditable()

Indicates if the user has permission to edit/delete the TimeBlock

Returns:

Y if user has a permission to edit/delete this time block, N if not

getPrincipalId

String getPrincipalId()

The principalId associated with the TimeBlock

principalId of a TimeBlock

Specified by:

getPrincipalId in interface CalendarBlockContract

Returns:

principalId for TimeBlock

getOvertimePref

String getOvertimePref()

TODO: Put a better comment The overtimePref associated with the TimeBlock

overtimePref of a TimeBlock

Specified by:

getOvertimePref in interface CalendarBlockContract

Returns:

overtimePref for TimeBlock

getActualBeginTimeString

String getActualBeginTimeString()

The actual begin time string associated with the TimeBlock

It applies grace period rule to times of time block. This string is for GUI of Actual time inquiry

Returns:

actual begin time string for TimeBlock

getActualEndTimeString

String getActualEndTimeString()

The actual end time string associated with the TimeBlock

It applies grace period rule to times of time block. This string is for GUI of Actual time inquiry

Returns:

actual end time string for TimeBlock

getDeleteable

Boolean getDeleteable()

Indicates if this user has a permission to delete this time block

Returns:

Y if user has a permission to delete this time block, N if not

getOvertimeEditable

Boolean getOvertimeEditable()

Indicates if overtime earn code can be edited

Returns:

Y if overtime earn code can be edited, N if not

getTimeBlockEditable

Boolean getTimeBlockEditable()

Indicates if this user has a permission to edit this time block

Returns:

Y if user has a permission to edit this time block, N if not

isLunchDeleted

boolean isLunchDeleted()

TODO: Make sure this comment is right The flag that indicates if lunch hour is deleted

lunchDeleted flag of a TimeBlock

Returns:

Y if deleted, N if not

getUser

org.kuali.rice.kim.api.identity.Person getUser()

The Person object associated with the TimeBlock

user of a TimeBlock

Returns:

user for TimeBlock

getHrCalendarBlockId

String getHrCalendarBlockId()

The id of the CalendarBlock object associated with the TimeBlock

super.hrCalendarBlockId a TimeBlock

Specified by:

getHrCalendarBlockId in interface CalendarBlockContract

Returns:

super.hrCalendarBlockId for TimeBlock