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

Interface TimeBlockContract

All Superinterfaces:

CalendarBlockContract, Comparable<TimeBlockContract>, org.kuali.rice.core.api.mo.common.GloballyUnique, KeyedData, KpmeDataTransferObject, KpmeKeyedDataTransferObject, UserModified, org.kuali.rice.core.api.mo.common.Versioned

All Known Subinterfaces:

TimeBlockHistoryContract

All Known Implementing Classes:

TimeBlock, TimeBlock.Builder, TimeBlockBo, TimeBlockHistory

public interface TimeBlockContract
extends CalendarBlockContract, UserModified, Comparable<TimeBlockContract>

TimeBlockContract interface

Method Summary

Methods

Modifier and Type	Method and Description
org.joda.time.DateTime	getActionDateTime()
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
String	getAssignmentValue()
org.joda.time.DateTime	getBeginDateTime() The beginTimestamp (Datetime) associated with the TimeBlock
org.joda.time.LocalTime	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.
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	getClockAction()
String	getClockLogBeginId() The clock log begin id associated with the TimeBlock
String	getClockLogEndId() The clock log end id associated with the TimeBlock
org.joda.time.DateTime	getCreateTime() The timestamp associated with the TimeBlock
String	getEarnCodeType() The earn code type associated with the TimeBlock
org.joda.time.DateTime	getEndDateTime() The endTimestamp (DateTime) associated with the TimeBlock
org.joda.time.LocalTime	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.
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
BigDecimal	getHours() The hours associated with the TimeBlock
String	getHrCalendarBlockId() The id of the CalendarBlock object associated with the TimeBlock
org.joda.time.DateTime	getLeaveDateTime()
String	getMissedPunchDocId()
String	getMissedPunchDocStatus()
String	getOvertimePref() TODO: Put a better comment The overtimePref associated with the TimeBlock
String	getPrincipalId() The principalId associated with the TimeBlock
List<? extends TimeHourDetailContract>	getTimeHourDetails() The list of TimeHourDetail objects associated with the TimeBlock
String	getTkTimeBlockId() The primary key of a TimeBlock entry saved in a database
BigDecimal	getTotalMinutes() The minutes associated with the TimeBlock (directly related to hours)
String	getUserPrincipalId() The userPrincipalId associated with the TimeBlock
Boolean	isClockedByMissedPunch()
Boolean	isClockLogCreated() Flag the shows if the timeblock has been created by a clock log
boolean	isLunchDeleted() TODO: Make sure this comment is right The flag that indicates if lunch hour is deleted
boolean	isMissedPunchClockIn()
boolean	isMissedPunchClockOut()
Boolean	isPushBackward() The flag that indicates if the TimeBlock will be pushed back or not

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

getConcreteBlockId, getConcreteBlockType, getDocumentId, getEarnCode, getJobNumber, getTask, getWorkArea

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.kpme.core.api.mo.KeyedData

getGroupKey, getGroupKeyCode

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getBeginTime

org.joda.time.LocalTime 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

Specified by:

getBeginDateTime in interface CalendarBlockContract

Returns:

new DateTime(beginTimestamp)

getEndTime

org.joda.time.LocalTime 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

Specified by:

getEndDateTime in interface CalendarBlockContract

Returns:

new DateTime(endTimestamp)

isClockLogCreated

Boolean isClockLogCreated()

Flag the shows if the timeblock has been created by a clock log

clockLogCreated flag of a Timeblock

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

getTotalMinutes

BigDecimal getTotalMinutes()

The minutes associated with the TimeBlock (directly related to hours)

total minutes of a TimeBlock

Returns:

total minutes 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

Specified by:

getUserPrincipalId in interface UserModified

Returns:

userPrincipalId for TimeBlock

getCreateTime

org.joda.time.DateTime getCreateTime()

The timestamp associated with the TimeBlock

timestamp of a TimeBlock

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

isPushBackward

Boolean isPushBackward()

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

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

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

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

isLunchDeleted

boolean isLunchDeleted()

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

lunchDeleted flag of a TimeBlock

Specified by:

isLunchDeleted in interface CalendarBlockContract

Returns:

Y if deleted, N if not

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

getLeaveDateTime

org.joda.time.DateTime getLeaveDateTime()

getActionDateTime

org.joda.time.DateTime getActionDateTime()

getClockAction

String getClockAction()

getMissedPunchDocId

String getMissedPunchDocId()

getMissedPunchDocStatus

String getMissedPunchDocStatus()

getAssignmentValue

String getAssignmentValue()

isClockedByMissedPunch

Boolean isClockedByMissedPunch()

isMissedPunchClockIn

boolean isMissedPunchClockIn()

isMissedPunchClockOut

boolean isMissedPunchClockOut()