org.kuali.kpme.tklm.api.leave.block

Interface LeaveBlockHistoryContract

All Superinterfaces:

CalendarBlockContract, LeaveBlockContract

All Known Implementing Classes:

LeaveBlockHistory

public interface LeaveBlockHistoryContract
extends LeaveBlockContract

LeaveBlockHistoryContract interface

Method Summary

Methods

Modifier and Type	Method and Description
String	getAction() The action associated with the LeaveBlockHistory
String	getAssignmentTitle() The assignment title associated with the LeaveBlockHistory
String	getLmLeaveBlockHistoryId() The primary key of a LeaveBlockHistory entry saved in a database
String	getPrincipalIdDeleted() TODO: Put a better comment The principalIdDeleted associated with the LeaveBlockHistory
Timestamp	getTimestampDeleted() TODO: Put a better comment The timestampDeleted associated with the LeaveBlockHistory

Methods inherited from interface org.kuali.kpme.tklm.api.leave.block.LeaveBlockContract

getAccrualCategory, getAccrualCategoryRuleId, getAccrualGenerated, getAssignmentKey, getBeginDateTime, getBlockId, getCalendarId, getDescription, getDocumentStatus, getEarnCode, getEarnCodeDescription, getEndDateTime, getJobNumber, getLeaveAmount, getLeaveBlockHistories, getLeaveBlockType, getLeaveDate, getLeaveLocalDate, getLeaveRequestDocumentId, getLmLeaveBlockId, getPlanningDescription, getReason, getRequestStatus, getRequestStatusString, getScheduleTimeOffId, getTask, getTransactionalDocId, getWorkArea, isDeletable, isEditable, isSubmit

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

getAmount, getBeginTimestamp, getConcreteBlockId, getConcreteBlockType, getDocumentId, getEndTimestamp, getHours, getHrCalendarBlockId, getLunchDeleted, getOvertimePref, getPrincipalId, getTimestamp, setAmount, setBeginTimestamp, setConcreteBlockId, setConcreteBlockType, setDocumentId, setEarnCode, setEndTimestamp, setHours, setHrCalendarBlockId, setJobNumber, setLunchDeleted, setOvertimePref, setPrincipalId, setTask, setTimestamp, setWorkArea

Method Detail

getLmLeaveBlockHistoryId

String getLmLeaveBlockHistoryId()

The primary key of a LeaveBlockHistory entry saved in a database

lmLeaveBlockHistoryId of a LeaveBlockHistory

Returns:

lmLeaveBlockHistoryId for LeaveBlockHistory

getAction

String getAction()

The action associated with the LeaveBlockHistory

action of a LeaveBlockHistory

Returns:

action for LeaveBlockHistory

getPrincipalIdDeleted

String getPrincipalIdDeleted()

TODO: Put a better comment The principalIdDeleted associated with the LeaveBlockHistory

principalIdDeleted of a LeaveBlockHistory

Returns:

principalIdDeleted for LeaveBlockHistory

getTimestampDeleted

Timestamp getTimestampDeleted()

TODO: Put a better comment The timestampDeleted associated with the LeaveBlockHistory

timestampDeleted of a LeaveBlockHistory

Returns:

timestampDeleted for LeaveBlockHistory

getAssignmentTitle

String getAssignmentTitle()

The assignment title associated with the LeaveBlockHistory

If the leave block associated with the LeaveBlockHistory is not null, it checks its work area. If the work area is not null, it gets its description and its task. If the task is not null and not the default task, it gets the task description.

Specified by:

getAssignmentTitle in interface LeaveBlockContract

Returns:

"work area description - task description" for LeaveBlockHistory