org.kuali.kpme.tklm.api.leave.payout
Interface LeavePayoutContract

All Superinterfaces:

org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.core.api.mo.common.GloballyUnique, HrBusinessObjectContract, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.PersistableBusinessObject, Serializable, org.kuali.rice.core.api.mo.common.Versioned

All Known Implementing Classes:

LeavePayout

public interface LeavePayoutContract
extends HrBusinessObjectContract

LeaveDonationContract interface

Method Summary

String	getAccrualCategoryRule() The AccrualCategoryRule name associated with the LeavePayout
String	getDescription() The descripton of the LeavePayout
String	getDocumentHeaderId() The documentHeaderId associated with the LeavePayout
String	getEarnCode() The EarnCode name associated with the LeavePayout
EarnCodeContract	getEarnCodeObj() The EarnCode object associated with the LeavePayout
BigDecimal	getForfeitedAmount() The computed amount of accrued leave that will be forfeited
String	getForfeitedLeaveBlockId() The forfeitedLeaveBlockId associated with the LeavePayout
String	getFromAccrualCategory() The AccrualCategory name that leave payout is made from
AccrualCategoryContract	getFromAccrualCategoryObj() The AccuralCategory object associated with the LeavePayout
List<? extends LeaveBlockContract>	getLeaveBlocks() The list of LeaveBlock objects associated with the LeavePayout
String	getLeaveCalendarDocumentId() The leaveCalendarDocumentId associated with the LeavePayout
String	getLeavePlan() The LeavePlan name of the PrincipalHRAttributes of the employee
String	getLmLeavePayoutId() The primary key of a LeavePayout entry saved in a database
String	getName() The principalName of the employee
BigDecimal	getPayoutAmount() The amount of accrued leave to payout
String	getPayoutFromLeaveBlockId() The payoutLeaveBlockId associated with the LeavePayout
String	getPayoutLeaveBlockId() The payoutFromLeaveBlockId associated with the LeavePayout
org.kuali.rice.kim.api.identity.Person	getPrincipal() The Person object associated with the LeavePayout
PrincipalHRAttributesContract	getPrincipalHRAttrObj() The PrincipalHRAttributes object associated with the LeavePayout
String	getPrincipalId() The principalID of the employee whom accruals are payed out to
String	getStatus() The status associated with the LeavePayout

Methods inherited from interface org.kuali.kpme.core.api.bo.HrBusinessObjectContract

getEffectiveDate, getEffectiveLocalDate, getId, getRelativeEffectiveDate, getTimestamp

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

buildListOfDeletionAwareLists, getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

isActive

Method Detail

getEarnCode

String getEarnCode()

The EarnCode name associated with the LeavePayout

earnCode of a LeavePayout

Returns:

earnCode for LeavePayout

getEarnCodeObj

EarnCodeContract getEarnCodeObj()

The EarnCode object associated with the LeavePayout

earnCodeObject of a LeavePayout

Returns:

earnCodeObject for LeavePayout

getPrincipalId

String getPrincipalId()

The principalID of the employee whom accruals are payed out to

principalId of a LeavePayout

Returns:

principalId for LeavePayout

getPrincipal

org.kuali.rice.kim.api.identity.Person getPrincipal()

The Person object associated with the LeavePayout

principal of a LeavePayout

Returns:

principal for LeavePayout

getName

String getName()

The principalName of the employee

principal.getName() of a LeavePayout

Returns:

principal.getName() for LeavePayout

getLeavePlan

String getLeavePlan()

The LeavePlan name of the PrincipalHRAttributes of the employee

principalHRAttrObj.getLeavePlan() of a LeavePayout

Returns:

principalHRAttrObj.getLeavePlan() for LeavePayout

getFromAccrualCategory

String getFromAccrualCategory()

The AccrualCategory name that leave payout is made from

fromAccrualCategory of a LeavePayout

Returns:

fromAccrualCategory for LeavePayout

getDescription

String getDescription()

The descripton of the LeavePayout

description of a LeavePayout

Returns:

description for LeavePayout

getPayoutAmount

BigDecimal getPayoutAmount()

The amount of accrued leave to payout

payoutAmount of a LeavePayout

Returns:

payoutAmount for LeavePayout

getForfeitedAmount

BigDecimal getForfeitedAmount()

The computed amount of accrued leave that will be forfeited

forfeitedAmount of a LeavePayout

Returns:

forfeitedAmount for LeavePayout

getFromAccrualCategoryObj

AccrualCategoryContract getFromAccrualCategoryObj()

The AccuralCategory object associated with the LeavePayout

accrualCategoryObj of a LeavePayout

Returns:

accrualCategoryObj for LeavePayout

getLmLeavePayoutId

String getLmLeavePayoutId()

The primary key of a LeavePayout entry saved in a database

hrEarnCodeId of a LeavePayout

Returns:

lmLeavePlanId for LeavePayout

getPrincipalHRAttrObj

PrincipalHRAttributesContract getPrincipalHRAttrObj()

The PrincipalHRAttributes object associated with the LeavePayout

principalHRAttrObj of a LeavePayout

Returns:

principalHRAttrObj for LeavePayout

getAccrualCategoryRule

String getAccrualCategoryRule()

The AccrualCategoryRule name associated with the LeavePayout

accrualCategoryRule of a LeavePayout

Returns:

accrualCategoryRule for LeavePayout

getForfeitedLeaveBlockId

String getForfeitedLeaveBlockId()

The forfeitedLeaveBlockId associated with the LeavePayout

forfeitedLeaveBlockId of a LeavePayout

Returns:

forfeitedLeaveBlockId for LeavePayout

getPayoutLeaveBlockId

String getPayoutLeaveBlockId()

The payoutFromLeaveBlockId associated with the LeavePayout

payoutFromLeaveBlockId of a LeavePayout

Returns:

payoutFromLeaveBlockId for LeavePayout

getPayoutFromLeaveBlockId

String getPayoutFromLeaveBlockId()

The payoutLeaveBlockId associated with the LeavePayout

payoutLeaveBlockId of a LeavePayout

Returns:

payoutLeaveBlockId for LeavePayout

getLeaveBlocks

List<? extends LeaveBlockContract> getLeaveBlocks()

The list of LeaveBlock objects associated with the LeavePayout

a list of LeaveBlock objects

Returns:

a list that contains LeaveBlock objects based on forfeitedLeaveBlockId, payoutLeaveBlockId, and payoutFromLeaveBlockId

getLeaveCalendarDocumentId

String getLeaveCalendarDocumentId()

The leaveCalendarDocumentId associated with the LeavePayout

leaveCalendarDocumentId of a LeavePayout

Returns:

leaveCalendarDocumentId for LeavePayout

getStatus

String getStatus()

The status associated with the LeavePayout

status of a LeavePayout

Returns:

status for LeavePayout

getDocumentHeaderId

String getDocumentHeaderId()

The documentHeaderId associated with the LeavePayout

documentHeaderId of a LeavePayout

Returns:

documentHeaderId for LeavePayout