org.kuali.kpme.tklm.leave.payout
Class LeavePayout

java.lang.Object
  org.kuali.rice.krad.bo.BusinessObjectBase
      org.kuali.rice.krad.bo.PersistableBusinessObjectBase
          org.kuali.kpme.core.bo.HrBusinessObject
              org.kuali.kpme.tklm.leave.payout.LeavePayout

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, Assignable, HrBusinessObjectContract, LeavePayoutContract, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

public class LeavePayout
extends HrBusinessObject
implements Assignable, LeavePayoutContract

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Fields inherited from interface org.kuali.kpme.core.api.assignment.Assignable

ASSIGNABLE_TERM_NAME

Constructor Summary

LeavePayout()

Method Summary

LeavePayout	adjust(BigDecimal payoutAmount)
String	getAccrualCategoryRule() The AccrualCategoryRule name associated with the LeavePayout
List<Assignment>	getAssignments()
String	getDescription() The descripton of the LeavePayout
String	getDocumentHeaderId() The documentHeaderId associated with the LeavePayout
String	getEarnCode() The EarnCode name associated with the LeavePayout
EarnCode	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
AccrualCategory	getFromAccrualCategoryObj() The AccuralCategory object associated with the LeavePayout
String	getId() The unique id defined by the object, could be a combination of multiple fields
List<LeaveBlock>	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
PrincipalHRAttributes	getPrincipalHRAttrObj() The PrincipalHRAttributes object associated with the LeavePayout
String	getPrincipalId() The principalID of the employee whom accruals are payed out to
static long	getSerialversionuid()
String	getStatus() The status associated with the LeavePayout
protected String	getUniqueKey()
void	setAccrualCategoryRule(String accrualCategoryRule)
void	setDescription(String description)
void	setDocumentHeaderId(String documentHeaderId)
void	setEarnCode(String earnCode)
void	setEarnCodeObj(EarnCode earnCodeObj)
void	setForfeitedAmount(BigDecimal amount)
void	setForfeitedLeaveBlockId(String forfeitedLeaveBlockId)
void	setFromAccrualCategory(String accrualCategory)
void	setFromAccrualCategoryObj(AccrualCategory accrualCategoryObj)
void	setId(String id)
void	setLeaveCalendarDocumentId(String leaveCalendarDocumentId)
void	setLeavePlan(String leavePlan)
void	setLmLeavePayoutId(String id)
void	setPayoutAmount(BigDecimal amount)
void	setPayoutFromLeaveBlockId(String payoutFromLeaveBlockId)
void	setPayoutLeaveBlockId(String payoutLeaveBlockId)
void	setPrincipal(org.kuali.rice.kim.api.identity.Person principal)
void	setPrincipalHRAttrObj(PrincipalHRAttributes hrObj)
void	setPrincipalId(String principalId)
void	setStatus(String code)

Methods inherited from class org.kuali.kpme.core.bo.HrBusinessObject

getEffectiveDate, getEffectiveLocalDate, getRelativeEffectiveDate, getTimestamp, isActive, setActive, setEffectiveDate, setEffectiveLocalDate, setRelativeEffectiveDate, setTimestamp

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getEffectiveDate, getEffectiveLocalDate, 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

Constructor Detail

LeavePayout

public LeavePayout()

Method Detail

getEarnCode

public String getEarnCode()

Description copied from interface: LeavePayoutContract

The EarnCode name associated with the LeavePayout

earnCode of a LeavePayout

Specified by:

getEarnCode in interface LeavePayoutContract

Returns:

earnCode for LeavePayout

setEarnCode

public void setEarnCode(String earnCode)

getEarnCodeObj

public EarnCode getEarnCodeObj()

Description copied from interface: LeavePayoutContract

The EarnCode object associated with the LeavePayout

earnCodeObject of a LeavePayout

Specified by:

getEarnCodeObj in interface LeavePayoutContract

Returns:

earnCodeObject for LeavePayout

setEarnCodeObj

public void setEarnCodeObj(EarnCode earnCodeObj)

getPrincipalId

public String getPrincipalId()

Description copied from interface: LeavePayoutContract

The principalID of the employee whom accruals are payed out to

principalId of a LeavePayout

Specified by:

getPrincipalId in interface LeavePayoutContract

Returns:

principalId for LeavePayout

setPrincipalId

public void setPrincipalId(String principalId)

getPrincipal

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

Description copied from interface: LeavePayoutContract

The Person object associated with the LeavePayout

principal of a LeavePayout

Specified by:

getPrincipal in interface LeavePayoutContract

Returns:

principal for LeavePayout

setPrincipal

public void setPrincipal(org.kuali.rice.kim.api.identity.Person principal)

getName

public String getName()

Description copied from interface: LeavePayoutContract

The principalName of the employee

principal.getName() of a LeavePayout

Specified by:

getName in interface LeavePayoutContract

Returns:

principal.getName() for LeavePayout

getLeavePlan

public String getLeavePlan()

Description copied from interface: LeavePayoutContract

The LeavePlan name of the PrincipalHRAttributes of the employee

principalHRAttrObj.getLeavePlan() of a LeavePayout

Specified by:

getLeavePlan in interface LeavePayoutContract

Returns:

principalHRAttrObj.getLeavePlan() for LeavePayout

setLeavePlan

public void setLeavePlan(String leavePlan)

getFromAccrualCategory

public String getFromAccrualCategory()

Description copied from interface: LeavePayoutContract

The AccrualCategory name that leave payout is made from

fromAccrualCategory of a LeavePayout

Specified by:

getFromAccrualCategory in interface LeavePayoutContract

Returns:

fromAccrualCategory for LeavePayout

setFromAccrualCategory

public void setFromAccrualCategory(String accrualCategory)

getDescription

public String getDescription()

Description copied from interface: LeavePayoutContract

The descripton of the LeavePayout

description of a LeavePayout

Specified by:

getDescription in interface LeavePayoutContract

Returns:

description for LeavePayout

setDescription

public void setDescription(String description)

getPayoutAmount

public BigDecimal getPayoutAmount()

Description copied from interface: LeavePayoutContract

The amount of accrued leave to payout

payoutAmount of a LeavePayout

Specified by:

getPayoutAmount in interface LeavePayoutContract

Returns:

payoutAmount for LeavePayout

setPayoutAmount

public void setPayoutAmount(BigDecimal amount)

getForfeitedAmount

public BigDecimal getForfeitedAmount()

Description copied from interface: LeavePayoutContract

The computed amount of accrued leave that will be forfeited

forfeitedAmount of a LeavePayout

Specified by:

getForfeitedAmount in interface LeavePayoutContract

Returns:

forfeitedAmount for LeavePayout

setForfeitedAmount

public void setForfeitedAmount(BigDecimal amount)

getFromAccrualCategoryObj

public AccrualCategory getFromAccrualCategoryObj()

Description copied from interface: LeavePayoutContract

The AccuralCategory object associated with the LeavePayout

accrualCategoryObj of a LeavePayout

Specified by:

getFromAccrualCategoryObj in interface LeavePayoutContract

Returns:

accrualCategoryObj for LeavePayout

setFromAccrualCategoryObj

public void setFromAccrualCategoryObj(AccrualCategory accrualCategoryObj)

getSerialversionuid

public static long getSerialversionuid()

getLmLeavePayoutId

public String getLmLeavePayoutId()

Description copied from interface: LeavePayoutContract

The primary key of a LeavePayout entry saved in a database

hrEarnCodeId of a LeavePayout

Specified by:

getLmLeavePayoutId in interface LeavePayoutContract

Returns:

lmLeavePlanId for LeavePayout

setLmLeavePayoutId

public void setLmLeavePayoutId(String id)

getUniqueKey

protected String getUniqueKey()

Specified by:

getUniqueKey in class HrBusinessObject

getId

public String getId()

Description copied from interface: HrBusinessObjectContract

The unique id defined by the object, could be a combination of multiple fields

id of HrBusinessObject

Specified by:

getId in interface HrBusinessObjectContract

Specified by:

getId in class HrBusinessObject

Returns:

id of HrBusinessObject

setId

public void setId(String id)

Specified by:

setId in class HrBusinessObject

getPrincipalHRAttrObj

public PrincipalHRAttributes getPrincipalHRAttrObj()

Description copied from interface: LeavePayoutContract

The PrincipalHRAttributes object associated with the LeavePayout

principalHRAttrObj of a LeavePayout

Specified by:

getPrincipalHRAttrObj in interface LeavePayoutContract

Returns:

principalHRAttrObj for LeavePayout

setPrincipalHRAttrObj

public void setPrincipalHRAttrObj(PrincipalHRAttributes hrObj)

getAccrualCategoryRule

public String getAccrualCategoryRule()

Description copied from interface: LeavePayoutContract

The AccrualCategoryRule name associated with the LeavePayout

accrualCategoryRule of a LeavePayout

Specified by:

getAccrualCategoryRule in interface LeavePayoutContract

Returns:

accrualCategoryRule for LeavePayout

setAccrualCategoryRule

public void setAccrualCategoryRule(String accrualCategoryRule)

getForfeitedLeaveBlockId

public String getForfeitedLeaveBlockId()

Description copied from interface: LeavePayoutContract

The forfeitedLeaveBlockId associated with the LeavePayout

forfeitedLeaveBlockId of a LeavePayout

Specified by:

getForfeitedLeaveBlockId in interface LeavePayoutContract

Returns:

forfeitedLeaveBlockId for LeavePayout

setForfeitedLeaveBlockId

public void setForfeitedLeaveBlockId(String forfeitedLeaveBlockId)

getPayoutLeaveBlockId

public String getPayoutLeaveBlockId()

Description copied from interface: LeavePayoutContract

The payoutFromLeaveBlockId associated with the LeavePayout

payoutFromLeaveBlockId of a LeavePayout

Specified by:

getPayoutLeaveBlockId in interface LeavePayoutContract

Returns:

payoutFromLeaveBlockId for LeavePayout

setPayoutLeaveBlockId

public void setPayoutLeaveBlockId(String payoutLeaveBlockId)

getPayoutFromLeaveBlockId

public String getPayoutFromLeaveBlockId()

Description copied from interface: LeavePayoutContract

The payoutLeaveBlockId associated with the LeavePayout

payoutLeaveBlockId of a LeavePayout

Specified by:

getPayoutFromLeaveBlockId in interface LeavePayoutContract

Returns:

payoutLeaveBlockId for LeavePayout

setPayoutFromLeaveBlockId

public void setPayoutFromLeaveBlockId(String payoutFromLeaveBlockId)

setLeaveCalendarDocumentId

public void setLeaveCalendarDocumentId(String leaveCalendarDocumentId)

getLeaveBlocks

public List<LeaveBlock> getLeaveBlocks()

Description copied from interface: LeavePayoutContract

The list of LeaveBlock objects associated with the LeavePayout

a list of LeaveBlock objects

Specified by:

getLeaveBlocks in interface LeavePayoutContract

Returns:

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

getLeaveCalendarDocumentId

public String getLeaveCalendarDocumentId()

Description copied from interface: LeavePayoutContract

The leaveCalendarDocumentId associated with the LeavePayout

leaveCalendarDocumentId of a LeavePayout

Specified by:

getLeaveCalendarDocumentId in interface LeavePayoutContract

Returns:

leaveCalendarDocumentId for LeavePayout

adjust

public LeavePayout adjust(BigDecimal payoutAmount)

getStatus

public String getStatus()

Description copied from interface: LeavePayoutContract

The status associated with the LeavePayout

status of a LeavePayout

Specified by:

getStatus in interface LeavePayoutContract

Returns:

status for LeavePayout

setStatus

public void setStatus(String code)

getDocumentHeaderId

public String getDocumentHeaderId()

Description copied from interface: LeavePayoutContract

The documentHeaderId associated with the LeavePayout

documentHeaderId of a LeavePayout

Specified by:

getDocumentHeaderId in interface LeavePayoutContract

Returns:

documentHeaderId for LeavePayout

setDocumentHeaderId

public void setDocumentHeaderId(String documentHeaderId)

getAssignments

public List<Assignment> getAssignments()

Specified by:

getAssignments in interface Assignable