TimeBlock (Kuali HR 2.1.1-SNAPSHOT API)

java.lang.Object
- org.kuali.rice.core.api.mo.AbstractDataTransferObject
- - org.kuali.kpme.tklm.api.time.timeblock.TimeBlock

All Implemented Interfaces:

Serializable, Comparable<TimeBlockContract>, CalendarBlockContract, KeyedData, KpmeDataTransferObject, KpmeKeyedDataTransferObject, UserModified, TimeBlockContract, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.ModelObjectComplete
```
public final class TimeBlock
extends org.kuali.rice.core.api.mo.AbstractDataTransferObject
implements TimeBlockContract
```
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TimeBlock.Builder
A builder which can be used to construct TimeBlock instances.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TimeBlock.Builder` A builder which can be used to construct `TimeBlock` instances.

Field Summary

Fields
Modifier and Type Field and Description

static String CACHE_NAME

Fields
Modifier and Type	Field and Description
`static String`	`CACHE_NAME`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(TimeBlockContract tb)`
`static TimeBlock`	`copy(TimeBlock timeBlock)`
`boolean`	`equals(Object obj)`
`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()`
`Boolean`	`getClockedByMissedPunch()`
`String`	`getClockLogBeginId()` The clock log begin id associated with the TimeBlock
`String`	`getClockLogEndId()` The clock log end id associated with the TimeBlock
`String`	`getConcreteBlockId()`
`String`	`getConcreteBlockType()`
`org.joda.time.DateTime`	`getCreateTime()` The timestamp associated with the TimeBlock
`String`	`getDocumentId()`
`String`	`getEarnCode()`
`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
`HrGroupKey`	`getGroupKey()`
`String`	`getGroupKeyCode()` The localDate format of the effective date of the HrBusinessObject
`BigDecimal`	`getHours()` The hours associated with the TimeBlock
`String`	`getHrCalendarBlockId()` The id of the CalendarBlock object associated with the TimeBlock
`Long`	`getJobNumber()`
`org.joda.time.DateTime`	`getLeaveDateTime()`
`String`	`getMissedPunchDocId()`
`String`	`getMissedPunchDocStatus()`
`String`	`getObjectId()`
`String`	`getOvertimePref()` TODO: Put a better comment The overtimePref associated with the TimeBlock
`String`	`getPrincipalId()` The principalId associated with the TimeBlock
`Long`	`getTask()`
`List<TimeHourDetail>`	`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
`Long`	`getVersionNumber()`
`Long`	`getWorkArea()`
`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 class org.kuali.rice.core.api.mo.AbstractDataTransferObject
afterUnmarshal, beforeUnmarshal, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CACHE_NAME
```
public static final String CACHE_NAME
```
    See Also:
    Constant Field Values
- Method Detail
  - getHours
```
public BigDecimal getHours()
```
    Description copied from interface: TimeBlockContract
    
    The hours associated with the TimeBlock
    hours of a TimeBlock
    
    Specified by:
    
    getHours in interface CalendarBlockContract
    
    Specified by:
    
    getHours in interface TimeBlockContract
    
    Returns:
    hours for TimeBlock
  - getEndDateTime
```
public org.joda.time.DateTime getEndDateTime()
```
    Description copied from interface: TimeBlockContract
    
    The endTimestamp (DateTime) associated with the TimeBlock
    endTimestamp wrapped in DateTime object of a TimeBlock
    
    Specified by:
    
    getEndDateTime in interface CalendarBlockContract
    
    Specified by:
    
    getEndDateTime in interface TimeBlockContract
    
    Returns:
    new DateTime(endTimestamp)
  - isClockLogCreated
```
public Boolean isClockLogCreated()
```
    Description copied from interface: TimeBlockContract
    
    Flag the shows if the timeblock has been created by a clock log
    clockLogCreated flag of a Timeblock
    
    Specified by:
    
    isClockLogCreated in interface TimeBlockContract
    
    Returns:
    Y if created, N if not
  - getBeginDateTime
```
public org.joda.time.DateTime getBeginDateTime()
```
    Description copied from interface: TimeBlockContract
    
    The beginTimestamp (Datetime) associated with the TimeBlock
    beginTimestamp wrapped in DateTime object of a TimeBlock
    
    Specified by:
    
    getBeginDateTime in interface CalendarBlockContract
    
    Specified by:
    
    getBeginDateTime in interface TimeBlockContract
    
    Returns:
    new DateTime(beginTimestamp)
  - getEndTime
```
public org.joda.time.LocalTime getEndTime()
```
    Description copied from interface: TimeBlockContract
    
    The endTimestamp (Time) associated with the TimeBlock
    endTimestamp wrapped in Time object of a TimeBlock
    
    Specified by:
    
    getEndTime in interface TimeBlockContract
    
    Returns:
    new Time(endTimestamp.getTime())
  - getAmount
```
public BigDecimal getAmount()
```
    Description copied from interface: TimeBlockContract
    
    The amount associated with the TimeBlock
    amount of a TimeBlock
    
    Specified by:
    
    getAmount in interface CalendarBlockContract
    
    Specified by:
    
    getAmount in interface TimeBlockContract
    
    Returns:
    amount for TimeBlock
  - getUserPrincipalId
```
public String getUserPrincipalId()
```
    Description copied from interface: TimeBlockContract
    
    The userPrincipalId associated with the TimeBlock
    userPrincipalId of a TimeBlock
    
    Specified by:
    
    getUserPrincipalId in interface UserModified
    
    Specified by:
    
    getUserPrincipalId in interface TimeBlockContract
    
    Returns:
    userPrincipalId for TimeBlock
  - getTkTimeBlockId
```
public String getTkTimeBlockId()
```
    Description copied from interface: TimeBlockContract
    
    The primary key of a TimeBlock entry saved in a database
    tkTimeBlockId of a TimeBlock
    
    Specified by:
    
    getTkTimeBlockId in interface TimeBlockContract
    
    Returns:
    tkTimeBlockId for TimeBlock
  - getTimeHourDetails
```
public List<TimeHourDetail> getTimeHourDetails()
```
    Description copied from interface: TimeBlockContract
    
    The list of TimeHourDetail objects associated with the TimeBlock
    timeHourDetails of a TimeBlock
    
    Specified by:
    
    getTimeHourDetails in interface TimeBlockContract
    
    Returns:
    timeHourDetails for TimeBlock
  - isPushBackward
```
public Boolean isPushBackward()
```
    Description copied from interface: TimeBlockContract
    
    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.
    
    Specified by:
    
    isPushBackward in interface TimeBlockContract
    
    Returns:
    Y if pushed back, N if not
  - getBeginTimeDisplay
```
public org.joda.time.DateTime getBeginTimeDisplay()
```
    Description copied from interface: TimeBlockContract
    
    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.
    
    Specified by:
    
    getBeginTimeDisplay in interface TimeBlockContract
    
    Returns:
    beginTimeDisplay for TimeBlock
  - getBeginTimeDisplayDateOnlyString
```
public String getBeginTimeDisplayDateOnlyString()
```
    Description copied from interface: TimeBlockContract
    
    The date portion of the Timeblock begin time associated with the TimeBlock
    
    Specified by:
    
    getBeginTimeDisplayDateOnlyString in interface TimeBlockContract
    
    Returns:
    a string representing the getBeginTimeDisplay() in MM/dd/yyyy format
  - getBeginTimeDisplayTimeOnlyString
```
public String getBeginTimeDisplayTimeOnlyString()
```
    Description copied from interface: TimeBlockContract
    
    The time portion of the Timeblock begin time associated with the TimeBlock
    
    Specified by:
    
    getBeginTimeDisplayTimeOnlyString in interface TimeBlockContract
    
    Returns:
    a string representing getBeginTimeDisplay() in hh:mm aa format
  - getEndTimeDisplayDateOnlyString
```
public String getEndTimeDisplayDateOnlyString()
```
    Description copied from interface: TimeBlockContract
    
    The date portion of the Timeblock end time associated with the TimeBlock
    
    Specified by:
    
    getEndTimeDisplayDateOnlyString in interface TimeBlockContract
    
    Returns:
    a string representing getEndTimeDisplay() in MM/dd/yyyy format
  - getEndTimeDisplayTimeOnlyString
```
public String getEndTimeDisplayTimeOnlyString()
```
    Description copied from interface: TimeBlockContract
    
    The time portion of the Timeblock end time associated with the TimeBlock
    
    Specified by:
    
    getEndTimeDisplayTimeOnlyString in interface TimeBlockContract
    
    Returns:
    a string representing the getEndTimeDisplay() in hh:mm aa format
  - getEndTimeDisplay
```
public org.joda.time.DateTime getEndTimeDisplay()
```
    Description copied from interface: TimeBlockContract
    
    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.
    
    Specified by:
    
    getEndTimeDisplay in interface TimeBlockContract
    
    Returns:
    endTimeDisplay for TimeBlock
  - getClockLogBeginId
```
public String getClockLogBeginId()
```
    Description copied from interface: TimeBlockContract
    
    The clock log begin id associated with the TimeBlock
    clockLogBeginId of a TimeBlock
    
    Specified by:
    
    getClockLogBeginId in interface TimeBlockContract
    
    Returns:
    clockLogBeginId for TimeBlock
  - getClockLogEndId
```
public String getClockLogEndId()
```
    Description copied from interface: TimeBlockContract
    
    The clock log end id associated with the TimeBlock
    clockLogEndId of a TimeBlock
    
    Specified by:
    
    getClockLogEndId in interface TimeBlockContract
    
    Returns:
    clockLogEndId for TimeBlock
  - getAssignmentKey
```
public String getAssignmentKey()
```
    Description copied from interface: TimeBlockContract
    
    The assignment key associated with the TimeBlock
    assignmentKey of a TimeBlock
    
    Specified by:
    
    getAssignmentKey in interface TimeBlockContract
    
    Returns:
    assignmentKey for TimeBlock
  - getAssignmentDescription
```
public String getAssignmentDescription()
```
    Description copied from interface: TimeBlockContract
    
    The assignment description associated with the TimeBlock
    assignment description of a TimeBlock
    
    Specified by:
    
    getAssignmentDescription in interface TimeBlockContract
    
    Returns:
    assignment description for TimeBlock
  - getEarnCodeType
```
public String getEarnCodeType()
```
    Description copied from interface: TimeBlockContract
    
    The earn code type associated with the TimeBlock
    earnCodeType of a TimeBlock
    
    Specified by:
    
    getEarnCodeType in interface TimeBlockContract
    
    Returns:
    earnCodeType for TimeBlock
  - getPrincipalId
```
public String getPrincipalId()
```
    Description copied from interface: TimeBlockContract
    
    The principalId associated with the TimeBlock
    principalId of a TimeBlock
    
    Specified by:
    
    getPrincipalId in interface CalendarBlockContract
    
    Specified by:
    
    getPrincipalId in interface TimeBlockContract
    
    Returns:
    principalId for TimeBlock
  - getOvertimePref
```
public String getOvertimePref()
```
    Description copied from interface: TimeBlockContract
    
    TODO: Put a better comment The overtimePref associated with the TimeBlock
    overtimePref of a TimeBlock
    
    Specified by:
    
    getOvertimePref in interface CalendarBlockContract
    
    Specified by:
    
    getOvertimePref in interface TimeBlockContract
    
    Returns:
    overtimePref for TimeBlock
  - getActualBeginTimeString
```
public String getActualBeginTimeString()
```
    Description copied from interface: TimeBlockContract
    
    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
    
    Specified by:
    
    getActualBeginTimeString in interface TimeBlockContract
    
    Returns:
    actual begin time string for TimeBlock
  - getActualEndTimeString
```
public String getActualEndTimeString()
```
    Description copied from interface: TimeBlockContract
    
    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
    
    Specified by:
    
    getActualEndTimeString in interface TimeBlockContract
    
    Returns:
    actual end time string for TimeBlock
  - isLunchDeleted
```
public boolean isLunchDeleted()
```
    Description copied from interface: TimeBlockContract
    
    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
    
    Specified by:
    
    isLunchDeleted in interface TimeBlockContract
    
    Returns:
    Y if deleted, N if not
  - getHrCalendarBlockId
```
public String getHrCalendarBlockId()
```
    Description copied from interface: TimeBlockContract
    
    The id of the CalendarBlock object associated with the TimeBlock
    super.hrCalendarBlockId a TimeBlock
    
    Specified by:
    
    getHrCalendarBlockId in interface CalendarBlockContract
    
    Specified by:
    
    getHrCalendarBlockId in interface TimeBlockContract
    
    Returns:
    super.hrCalendarBlockId for TimeBlock
  - getBeginTime
```
public org.joda.time.LocalTime getBeginTime()
```
    Description copied from interface: TimeBlockContract
    
    The beginTimestamp (Time) associated with the TimeBlock
    beginTimestamp wrapped in Time object of a TimeBlock
    
    Specified by:
    
    getBeginTime in interface TimeBlockContract
    
    Returns:
    new Time(beginTimestamp.getTime())
  - getCreateTime
```
public org.joda.time.DateTime getCreateTime()
```
    Description copied from interface: TimeBlockContract
    
    The timestamp associated with the TimeBlock
    timestamp of a TimeBlock
    
    Specified by:
    
    getCreateTime in interface TimeBlockContract
    
    Returns:
    timestamp for TimeBlock
  - getWorkArea
```
public Long getWorkArea()
```
    Specified by:
    
    getWorkArea in interface CalendarBlockContract
  - getJobNumber
```
public Long getJobNumber()
```
    Specified by:
    
    getJobNumber in interface CalendarBlockContract
  - getGroupKey
```
public HrGroupKey getGroupKey()
```
    Specified by:
    
    getGroupKey in interface KeyedData
  - getGroupKeyCode
```
public String getGroupKeyCode()
```
    Description copied from interface: KeyedData
    
    The localDate format of the effective date of the HrBusinessObject
    effectiveLocalDate of HrBusinessObject
    
    Specified by:
    
    getGroupKeyCode in interface KeyedData
    
    Returns:
    effectiveLocalDate of HrBusinessObject
  - getTask
```
public Long getTask()
```
    Specified by:
    
    getTask in interface CalendarBlockContract
  - getEarnCode
```
public String getEarnCode()
```
    Specified by:
    
    getEarnCode in interface CalendarBlockContract
  - getConcreteBlockType
```
public String getConcreteBlockType()
```
    Specified by:
    
    getConcreteBlockType in interface CalendarBlockContract
  - getConcreteBlockId
```
public String getConcreteBlockId()
```
    Specified by:
    
    getConcreteBlockId in interface CalendarBlockContract
  - getDocumentId
```
public String getDocumentId()
```
    Specified by:
    
    getDocumentId in interface CalendarBlockContract
  - getObjectId
```
public String getObjectId()
```
    Specified by:
    
    getObjectId in interface org.kuali.rice.core.api.mo.common.GloballyUnique
  - getVersionNumber
```
public Long getVersionNumber()
```
    Specified by:
    
    getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned
  - getLeaveDateTime
```
public org.joda.time.DateTime getLeaveDateTime()
```
    Specified by:
    
    getLeaveDateTime in interface TimeBlockContract
  - isClockedByMissedPunch
```
public Boolean isClockedByMissedPunch()
```
    Specified by:
    
    isClockedByMissedPunch in interface TimeBlockContract
  - getClockedByMissedPunch
```
public Boolean getClockedByMissedPunch()
```
  - getAssignmentValue
```
public String getAssignmentValue()
```
    Specified by:
    
    getAssignmentValue in interface TimeBlockContract
  - getMissedPunchDocStatus
```
public String getMissedPunchDocStatus()
```
    Specified by:
    
    getMissedPunchDocStatus in interface TimeBlockContract
  - getMissedPunchDocId
```
public String getMissedPunchDocId()
```
    Specified by:
    
    getMissedPunchDocId in interface TimeBlockContract
  - getClockAction
```
public String getClockAction()
```
    Specified by:
    
    getClockAction in interface TimeBlockContract
  - getActionDateTime
```
public org.joda.time.DateTime getActionDateTime()
```
    Specified by:
    
    getActionDateTime in interface TimeBlockContract
  - isMissedPunchClockIn
```
public boolean isMissedPunchClockIn()
```
    Specified by:
    
    isMissedPunchClockIn in interface TimeBlockContract
  - isMissedPunchClockOut
```
public boolean isMissedPunchClockOut()
```
    Specified by:
    
    isMissedPunchClockOut in interface TimeBlockContract
  - getTotalMinutes
```
public BigDecimal getTotalMinutes()
```
    Description copied from interface: TimeBlockContract
    
    The minutes associated with the TimeBlock (directly related to hours)
    total minutes of a TimeBlock
    
    Specified by:
    
    getTotalMinutes in interface TimeBlockContract
    
    Returns:
    total minutes for TimeBlock
  - copy
```
public static TimeBlock copy(TimeBlock timeBlock)
```
  - compareTo
```
public int compareTo(TimeBlockContract tb)
```
    Specified by:
    
    compareTo in interface Comparable<TimeBlockContract>
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface org.kuali.rice.core.api.mo.ModelObjectComplete
    
    Overrides:
    
    equals in class org.kuali.rice.core.api.mo.AbstractDataTransferObject

Class TimeBlock

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

Methods inherited from class java.lang.Object

Field Detail

CACHE_NAME

Method Detail

getHours

getEndDateTime

isClockLogCreated

getBeginDateTime

getEndTime

getAmount

getUserPrincipalId

getTkTimeBlockId

getTimeHourDetails

isPushBackward

getBeginTimeDisplay

getBeginTimeDisplayDateOnlyString

getBeginTimeDisplayTimeOnlyString

getEndTimeDisplayDateOnlyString

getEndTimeDisplayTimeOnlyString

getEndTimeDisplay

getClockLogBeginId

getClockLogEndId

getAssignmentKey

getAssignmentDescription

getEarnCodeType

getPrincipalId

getOvertimePref

getActualBeginTimeString

getActualEndTimeString

isLunchDeleted

getHrCalendarBlockId

getBeginTime

getCreateTime

getWorkArea

getJobNumber

getGroupKey

getGroupKeyCode

getTask

getEarnCode

getConcreteBlockType

getConcreteBlockId

getDocumentId

getObjectId

getVersionNumber

getLeaveDateTime

isClockedByMissedPunch

getClockedByMissedPunch

getAssignmentValue

getMissedPunchDocStatus

getMissedPunchDocId

getClockAction

getActionDateTime

isMissedPunchClockIn

isMissedPunchClockOut

getTotalMinutes

copy

compareTo

equals