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

All Known Implementing Classes:

LeaveBlockRenderer

public interface LeaveBlockRendererContract

LeaveBlockRendererContract interface

Method Summary

String	getAssignmentClass() The assignment class associated with the LeaveBlockRenderer
String	getAssignmentTitle() The assignment title of the LeaveBlock object associated with the LeaveBlockRenderer
String	getDescription() The description of the LeaveBlock object associated with the LeaveBlockRenderer
String	getDocumentId() The document id of the LeaveBlock object associated with the LeaveBlockRenderer
String	getEarnCode() The EarnCode name of the LeaveBlock object associated with the LeaveBlockRenderer
BigDecimal	getHours() The leave amount of the LeaveBlock object associated with the LeaveBlockRenderer
LeaveBlockContract	getLeaveBlock() The LeaveBlock object associated with the LeaveBlockRenderer
String	getLeaveBlockDetails() The details of the LeaveBlock object associated with the LeaveBlockRenderer
String	getLeaveBlockId() The leave block id of the LeaveBlock object associated with the LeaveBlockRenderer
String	getRequestStatusClass() The request status string of the LeaveBlock object associated with the LeaveBlockRenderer
String	getTimeRange() The time range of the LeaveBlock object associated with the LeaveBlockRenderer
boolean	isDeletable() The deletable flag of the LeaveBlock object associated with the LeaveBlockRenderer
boolean	isEditable() The editable flag of the LeaveBlock object associated with the LeaveBlockRenderer

Method Detail

getLeaveBlock

LeaveBlockContract getLeaveBlock()

The LeaveBlock object associated with the LeaveBlockRenderer

leaveBlock of a LeaveBlockRenderer

Returns:

leaveBlock for LeaveBlockRenderer

getHours

BigDecimal getHours()

The leave amount of the LeaveBlock object associated with the LeaveBlockRenderer

leaveBlock.getLeaveAmount() of a LeaveBlockRenderer

Returns:

leaveBlock.getLeaveAmount() for LeaveBlockRenderer

getEarnCode

String getEarnCode()

The EarnCode name of the LeaveBlock object associated with the LeaveBlockRenderer

leaveBlock.getEarnCode() of a LeaveBlockRenderer

Returns:

leaveBlock.getEarnCode() for LeaveBlockRenderer

getLeaveBlockId

String getLeaveBlockId()

The leave block id of the LeaveBlock object associated with the LeaveBlockRenderer

leaveBlock.getLmLeaveBlockId() of a LeaveBlockRenderer

Returns:

leaveBlock.getLmLeaveBlockId() for LeaveBlockRenderer

getDocumentId

String getDocumentId()

The document id of the LeaveBlock object associated with the LeaveBlockRenderer

leaveBlock.getDocumentId() of a LeaveBlockRenderer

Returns:

leaveBlock.getDocumentId() for LeaveBlockRenderer

getAssignmentTitle

String getAssignmentTitle()

The assignment title of the LeaveBlock object associated with the LeaveBlockRenderer

leaveBlock.getAssignmentTitle() of a LeaveBlockRenderer

Returns:

leaveBlock.getAssignmentTitle() for LeaveBlockRenderer

isEditable

boolean isEditable()

The editable flag of the LeaveBlock object associated with the LeaveBlockRenderer

leaveBlock.isEditable() of a LeaveBlockRenderer

Returns:

leaveBlock.isEditable() for LeaveBlockRenderer

isDeletable

boolean isDeletable()

The deletable flag of the LeaveBlock object associated with the LeaveBlockRenderer

leaveBlock.isDeletable() of a LeaveBlockRenderer

Returns:

leaveBlock.isDeletable() for LeaveBlockRenderer

getAssignmentClass

String getAssignmentClass()

The assignment class associated with the LeaveBlockRenderer

assignmentClass of a LeaveBlockRenderer

Returns:

assignmentClass for LeaveBlockRenderer

getRequestStatusClass

String getRequestStatusClass()

The request status string of the LeaveBlock object associated with the LeaveBlockRenderer

leaveBlock.getRequestStatusString().toLowerCase() of an LeaveBlockRenderer

Returns:

leaveBlock.getRequestStatusString().toLowerCase() for LeaveBlockRenderer

getLeaveBlockDetails

String getLeaveBlockDetails()

The details of the LeaveBlock object associated with the LeaveBlockRenderer

If the leave block type is Accrual Service if the ScheduleTimeOffId of the leave block is not null, return the description of the ScheduleTimeOff, else "accrual" If the leave block type is Carry Over Adjustment if the description of the leave block is Max carry over adjustment, return "carryover adjustment", else "adjustment" If the leave block type is Balance Transfer if the description of the leave block contains Forfeited, return "transfer forfeiture" else if it contains Amount transferred, return "amount transferred" else if it contains Transferred amount, return "transferred amount" else "balance transfer" If the leave block type is Leave Payout if the description of the leave block contains Forfeited, return "payout forfeiture" else if it contains Amount paid out, return "amount paid out" else if it contains Payout amount, return "payout amount" else "leave payout" Else if the leave block type is not Leave Calendar nor Time Calendar, return corresponding string in LEAVE_BLOCK_TYPE_MAP for the leave block type else return leaveBlock.getRequestStatusString()

Returns:

see above

getDescription

String getDescription()

The description of the LeaveBlock object associated with the LeaveBlockRenderer

leaveBlock.getDescription() of a LeaveBlockRenderer

Returns:

leaveBlock.getDescription() for LeaveBlockRenderer

getTimeRange

String getTimeRange()

The time range of the LeaveBlock object associated with the LeaveBlockRenderer

If the begin timestamp and end timestamp of the LeaveBlock are not null, and If the earn code type of the LeaveBlock is "T", it constructs and returns a string that contains begin timestamp and end timestamp.

Returns:

"leaveBlock.getBeginDateTime() in (hh:mm aa) - leaveBlock.getEndDateTime() in (hh:mm aa)" for LeaveBlockRenderer