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

Interface LeaveBlockDisplayContract

All Known Implementing Classes:

LeaveBlockDisplay

public interface LeaveBlockDisplayContract

LeaveBlockDisplayContract interface

Method Summary

Methods

Modifier and Type	Method and Description
BigDecimal	getAccrualBalance(String accrualCategory) The accrual balance associated with the LeaveBlockDisplay
Collection<BigDecimal>	getAccrualBalances() The accrual balances associated with the LeaveBlockDisplay
String	getAccrualCategory() The accrual category associated with the LeaveBlockDisplay
String	getAssignmentTitle() The assignment title associated with the LeaveBlockDisplay
String	getCalendarId() The calendar id associated with the LeaveBlockDisplay
String	getDescription() The description associated with the LeaveBlockDisplay
String	getDocumentId() The document id associated with the LeaveBlockDisplay
String	getDocumentStatus() The document status associated with the LeaveBlockDisplay
String	getEarnCode() The earn code associated with the LeaveBlockDisplay
BigDecimal	getLeaveAmount() The leave amount associated with the LeaveBlockDisplay
Date	getLeaveDate() The leave date associated with the LeaveBlockDisplay
String	getRequestStatus() The request status associated with the LeaveBlockDisplay
Timestamp	getTimestamp() The time stamp associated with the LeaveBlockDisplay

Method Detail

getLeaveDate

Date getLeaveDate()

The leave date associated with the LeaveBlockDisplay

Returns:

leaveBlock.getLeaveDate()

getDocumentId

String getDocumentId()

The document id associated with the LeaveBlockDisplay

Returns:

leaveBlock.getDocumentId()

getCalendarId

String getCalendarId()

The calendar id associated with the LeaveBlockDisplay

Returns:

leaveBlock.getCalendarId()

getEarnCode

String getEarnCode()

The earn code associated with the LeaveBlockDisplay

Returns:

leaveBlock.getEarnCode()

getDescription

String getDescription()

The description associated with the LeaveBlockDisplay

If leaveBlock.getDescription() is null, call private retrieveDescriptionAccordingToLeaveType method

Returns:

leaveBlock.getDescription() if not null

getRequestStatus

String getRequestStatus()

The request status associated with the LeaveBlockDisplay

If leaveBlock.getRequestStatus() is not null, it returns HrConstants.REQUEST_STATUS_STRINGS for the status

Returns:

HrConstants.REQUEST_STATUS_STRINGS for the leave block's request status

getDocumentStatus

String getDocumentStatus()

The document status associated with the LeaveBlockDisplay

If leaveBlock.getDocumentId() is not null, it gets leave calendar document header based on the document id and returns KewApiConstants.DOCUMENT_STATUSES for the header's document status

Returns:

KewApiConstants.DOCUMENT_STATUSES of the header document

getLeaveAmount

BigDecimal getLeaveAmount()

The leave amount associated with the LeaveBlockDisplay

Returns:

leaveBlock.getLeaveAmount()

getTimestamp

Timestamp getTimestamp()

The time stamp associated with the LeaveBlockDisplay

Returns:

leaveBlock.getTimestamp()

getAssignmentTitle

String getAssignmentTitle()

The assignment title associated with the LeaveBlockDisplay

Returns:

leaveBlock.getAssignmentTitle()

getAccrualCategory

String getAccrualCategory()

The accrual category associated with the LeaveBlockDisplay

Returns:

leaveBlock.getAccrualCategory()

getAccrualBalances

Collection<BigDecimal> getAccrualBalances()

The accrual balances associated with the LeaveBlockDisplay

Returns:

accrualBalances.values();

getAccrualBalance

BigDecimal getAccrualBalance(String accrualCategory)

The accrual balance associated with the LeaveBlockDisplay

Parameters:

String - to retrieve accrual balance from the accrual balances collection

Returns:

accrualBalances.get(accrualCategory)