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

All Superinterfaces:

CalendarBlockContract

All Known Subinterfaces:

LeaveBlockHistoryContract

All Known Implementing Classes:

LeaveBlock, LeaveBlockHistory

public interface LeaveBlockContract
extends CalendarBlockContract

LeaveBlockContract interface

Method Summary

String	getAccrualCategory() The AccrualCategory name associated with the LeaveBlock
String	getAccrualCategoryRuleId() The AccrualCategoryRuleId associated with the LeaveBlock
Boolean	getAccrualGenerated() The accrualGenerated flag to indicate if the accrual is generated or not
String	getAssignmentKey() The assignment key associated with the LeaveBlock
String	getAssignmentTitle() The assignment title associated with the LeaveBlock
org.joda.time.DateTime	getBeginDateTime() The begin timestamp (DateTime) associated with the LeaveBlock
Long	getBlockId() TODO: What is this used for? Different from lmLeaveBlockId?? The blockId associated with the LeaveBlock
String	getCalendarId() The calendar id associated with the LeaveBlock
String	getDescription() The description associated with the LeaveBlock
String	getDocumentStatus() The document status associated with the LeaveBlock
String	getEarnCode() The EarnCode name associated with the LeaveBlock
String	getEarnCodeDescription() The description of the earn code associated with the LeaveBlock
org.joda.time.DateTime	getEndDateTime() The end timestamp (DateTime) associated with the LeaveBlock
Long	getJobNumber() The job number associated with the LeaveBlock
BigDecimal	getLeaveAmount() The leave amount associated with the LeaveBlock
List<? extends LeaveBlockHistoryContract>	getLeaveBlockHistories() The list of LeaveBlockHistory objects associated with the LeaveBlock
String	getLeaveBlockType() The type of leave block associated with the LeaveBlock
Date	getLeaveDate() The leave date (Date) associated with the LeaveBlock
org.joda.time.LocalDate	getLeaveLocalDate() The leave date (LocalDate) associated with the LeaveBlock
String	getLeaveRequestDocumentId() The document id of the leave request associated with the LeaveBlock
String	getLmLeaveBlockId() The primary key of a LeaveBlock entry saved in a database
String	getPlanningDescription() TODO: Put a better comment The planning description associated with the LeaveBlock
String	getReason() The reason associated with the LeaveBlock
String	getRequestStatus() The requestStatus associated with the LeaveBlock
String	getRequestStatusString() The value of requestStatus associated with the LeaveBlock
String	getScheduleTimeOffId() The scheduleTimeOffId associated with the LeaveBlock
Long	getTask() The task number associated with the LeaveBlock
String	getTransactionalDocId() TODO: Put a better comment The transactional document id associated with the LeaveBlock
Long	getWorkArea() The workArea number associated with the LeaveBlock
boolean	isDeletable() Indicates if the principal has a permission to delete the leave block
boolean	isEditable() Indicates if the principal has a permission to edit a leave block
boolean	isSubmit() TODO: Put a better comment The submit flag of the LeaveBlock

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

getAccrualCategoryRuleId

String getAccrualCategoryRuleId()

The AccrualCategoryRuleId associated with the LeaveBlock

It gets AccrualCategoryRule based on the AccrualCategory and PrincipalHRAttributes.

Returns:

lmAccrualCategoryRuleId if AccrualCategoryRule is not null

getAccrualCategory

String getAccrualCategory()

The AccrualCategory name associated with the LeaveBlock

It gets AccrualCategory based on the principal id and leave local date.

Returns:

accrualCategory for LeaveBlock

getAccrualGenerated

Boolean getAccrualGenerated()

The accrualGenerated flag to indicate if the accrual is generated or not

accrualGenerated of a LeaveBlock

Returns:

Y if accrual is generated, N if not

isSubmit

boolean isSubmit()

TODO: Put a better comment The submit flag of the LeaveBlock

submit of a LeaveBlock

Returns:

Y if submitted, N if not

getBlockId

Long getBlockId()

TODO: What is this used for? Different from lmLeaveBlockId?? The blockId associated with the LeaveBlock

blockId of a LeaveBlock

Returns:

blockId for LeaveBlock

getDescription

String getDescription()

The description associated with the LeaveBlock

description of a LeaveBlock

Returns:

description for LeaveBlock

getLeaveDate

Date getLeaveDate()

The leave date (Date) associated with the LeaveBlock

leaveDate of a LeaveBlock

Returns:

leaveDate for LeaveBlock

getLeaveLocalDate

org.joda.time.LocalDate getLeaveLocalDate()

The leave date (LocalDate) associated with the LeaveBlock

leaveDate of a LeaveBlock

Returns:

leaveDate in LocalDate for LeaveBlock

getScheduleTimeOffId

String getScheduleTimeOffId()

The scheduleTimeOffId associated with the LeaveBlock

scheduleTimeOffId of a LeaveBlock

Returns:

scheduleTimeOffId for LeaveBlock

getRequestStatus

String getRequestStatus()

The requestStatus associated with the LeaveBlock

requestStatus of a LeaveBlock

Returns:

requestStatus for LeaveBlock

getRequestStatusString

String getRequestStatusString()

The value of requestStatus associated with the LeaveBlock

value of requestStatus of a LeaveBlock

Returns:

value for requestStatus in REQUEST_STATUS_STRINGS map if found, "usage" if not found

getLeaveBlockHistories

List<? extends LeaveBlockHistoryContract> getLeaveBlockHistories()

The list of LeaveBlockHistory objects associated with the LeaveBlock

leaveBlockHistories of a LeaveBlock

Returns:

leaveBlockHistories for LeaveBlock

getReason

String getReason()

The reason associated with the LeaveBlock

reason of a LeaveBlock

Returns:

reason for LeaveBlock

getAssignmentTitle

String getAssignmentTitle()

The assignment title associated with the LeaveBlock

If the work area associated with the LeaveBlock 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.

Returns:

"work area description - task description" for LeaveBlock

getCalendarId

String getCalendarId()

The calendar id associated with the LeaveBlock

calendarId of a LeaveBlock

Returns:

calendarId for LeaveBlock

getEarnCodeDescription

String getEarnCodeDescription()

The description of the earn code associated with the LeaveBlock

earnCodeObj.getDescription() of a LeaveBlock

Returns:

earnCodeObj.getDescription() for LeaveBlock

getLeaveBlockType

String getLeaveBlockType()

The type of leave block associated with the LeaveBlock

leaveBlockType of a LeaveBlock

Returns:

leaveBlockType for LeaveBlock

isEditable

boolean isEditable()

Indicates if the principal has a permission to edit a leave block

Returns:

Y if the principal has a permission to edit a leave block, N if not

isDeletable

boolean isDeletable()

Indicates if the principal has a permission to delete the leave block

Returns:

Y if the principal has a permission to delete the leave block, N if not

getAssignmentKey

String getAssignmentKey()

The assignment key associated with the LeaveBlock

The key is consisted of job number, work area number, and task number

Returns:

assignmentKey for LeaveBlock

getDocumentStatus

String getDocumentStatus()

The document status associated with the LeaveBlock

documentStatus of a LeaveBlock

Returns:

documentStatus for LeaveBlock

getLeaveRequestDocumentId

String getLeaveRequestDocumentId()

The document id of the leave request associated with the LeaveBlock

leaveRequestDocumentId of a LeaveBlock

Returns:

leaveRequestDocumentId for LeaveBlock

getPlanningDescription

String getPlanningDescription()

TODO: Put a better comment The planning description associated with the LeaveBlock

planningDescription of a LeaveBlock

Returns:

planningDescription for LeaveBlock

getTransactionalDocId

String getTransactionalDocId()

TODO: Put a better comment The transactional document id associated with the LeaveBlock

transactionalDocId of a LeaveBlock

Returns:

transactionalDocId for LeaveBlock

getBeginDateTime

org.joda.time.DateTime getBeginDateTime()

The begin timestamp (DateTime) associated with the LeaveBlock

beginTimestamp of a LeaveBlock

Returns:

beginTimestamp for LeaveBlock

getEndDateTime

org.joda.time.DateTime getEndDateTime()

The end timestamp (DateTime) associated with the LeaveBlock

endTimestamp of a LeaveBlock

Returns:

endTimestamp for LeaveBlock

getLmLeaveBlockId

String getLmLeaveBlockId()

The primary key of a LeaveBlock entry saved in a database

lmLeaveBlockId of a LeaveBlock

Returns:

lmLeaveBlockId for LeaveBlock

getLeaveAmount

BigDecimal getLeaveAmount()

The leave amount associated with the LeaveBlock

leaveAmount of a LeaveBlock

Returns:

leaveAmount for LeaveBlock

getWorkArea

Long getWorkArea()

The workArea number associated with the LeaveBlock

workArea of a LeaveBlock

Specified by:

getWorkArea in interface CalendarBlockContract

Returns:

workArea for LeaveBlock

getJobNumber

Long getJobNumber()

The job number associated with the LeaveBlock

jobNumber of a LeaveBlock

Specified by:

getJobNumber in interface CalendarBlockContract

Returns:

jobNumber for LeaveBlock

getTask

Long getTask()

The task number associated with the LeaveBlock

task of a LeaveBlock

Specified by:

getTask in interface CalendarBlockContract

Returns:

task for LeaveBlock

getEarnCode

String getEarnCode()

The EarnCode name associated with the LeaveBlock

earnCode of a LeaveBlock

Specified by:

getEarnCode in interface CalendarBlockContract

Returns:

earnCode for LeaveBlock