org.kuali.kpme.tklm.leave.transfer

Class BalanceTransfer

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.transfer.BalanceTransfer

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, Assignable, HrBusinessObjectContract, BalanceTransferContract, 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 BalanceTransfer
extends HrBusinessObject
implements Assignable, BalanceTransferContract

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

Constructors

Constructor and Description
BalanceTransfer()

Method Summary

Methods

Modifier and Type	Method and Description
BalanceTransfer	adjust(BigDecimal transferAmount) Returns a balance transfer object adjusted for the new transfer amount.
void	approve()
void	cancel()
void	disapprove()
String	getAccrualCategoryRule() The AccrualCategoryRule name associated with the BalanceTransfer
String	getAccruedLeaveBlockId() The accrued leave block id associated with the BalanceTransfer
BigDecimal	getAmountTransferred() The amount transfered
List<Assignment>	getAssignments()
String	getBalanceTransferId() The primary key of a BalanceTransfer entry saved in a database
AccrualCategory	getCreditedAccrualCategory() The AccrualCategory object that the leave is transfered to
AccrualCategory	getDebitedAccrualCategory() The AccrualCategory object that the leave is transfered from
String	getDebitedLeaveBlockId() The debited leave block id associated with the BalanceTransfer
String	getDocumentHeaderId() The document header id associated with the BalanceTransfer
BigDecimal	getForfeitedAmount() The computed amount of accrued leave that will be forfeited
String	getForfeitedLeaveBlockId() The forfeited leave block id associated with the BalanceTransfer
String	getFromAccrualCategory() The AccrualCategory name that the leave is transfered from
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 BalanceTransfer
String	getLeaveCalendarDocumentId() The leave calendar document id associated with the BalanceTransfer
org.kuali.rice.kim.api.identity.Person	getPrincipal() The Person object of the user associated with the BalanceTransfer
String	getPrincipalId() The principalId of the user associated with the BalanceTransfer
String	getSstoId() TODO: Put a better comment
String	getStatus() The status associated with the BalanceTransfer
String	getToAccrualCategory() The AccrualCategory name that the leave is transfered to
BigDecimal	getTransferAmount() The amount of accrued leave to transfer
protected String	getUniqueKey()
void	setAccrualCategoryRule(String accrualCategoryRule)
void	setAccruedLeaveBlockId(String accruedLeaveBlockId)
void	setAmountTransferred(BigDecimal amountTransferrerd)
void	setBalanceTransferId(String balanceTransferId)
void	setDebitedLeaveBlockId(String debitedLeaveBlockId)
void	setDocumentHeaderId(String documentHeaderId)
void	setForfeitedAmount(BigDecimal forfeitedAmount)
void	setForfeitedLeaveBlockId(String forfeitedLeaveBlockId)
void	setFromAccrualCategory(String fromAccrualCategory)
void	setId(String id)
void	setLeaveCalendarDocumentId(String leaveCalendarDocumentId)
void	setPrincipal(org.kuali.rice.kim.api.identity.Person principal)
void	setPrincipalId(String principalId)
void	setSstoId(String sstoId)
void	setStatus(String status)
void	setToAccrualCategory(String toAccrualCategory)
void	setTransferAmount(BigDecimal transferAmount)

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

BalanceTransfer

public BalanceTransfer()

Method Detail

getPrincipalId

public String getPrincipalId()

Description copied from interface: BalanceTransferContract

The principalId of the user associated with the BalanceTransfer

principalId of a BalanceTransfer

Specified by:

getPrincipalId in interface BalanceTransferContract

Returns:

principalId for BalanceTransfer

setPrincipalId

public void setPrincipalId(String principalId)

getToAccrualCategory

public String getToAccrualCategory()

Description copied from interface: BalanceTransferContract

The AccrualCategory name that the leave is transfered to

toAccrualCategory of a BalanceTransfer

Specified by:

getToAccrualCategory in interface BalanceTransferContract

Returns:

toAccrualCategory for BalanceTransfer

setToAccrualCategory

public void setToAccrualCategory(String toAccrualCategory)

getFromAccrualCategory

public String getFromAccrualCategory()

Description copied from interface: BalanceTransferContract

The AccrualCategory name that the leave is transfered from

fromAccrualCategory of a BalanceTransfer

Specified by:

getFromAccrualCategory in interface BalanceTransferContract

Returns:

fromAccrualCategory for BalanceTransfer

setFromAccrualCategory

public void setFromAccrualCategory(String fromAccrualCategory)

getTransferAmount

public BigDecimal getTransferAmount()

Description copied from interface: BalanceTransferContract

The amount of accrued leave to transfer

transferAmount of a BalanceTransfer

Specified by:

getTransferAmount in interface BalanceTransferContract

Returns:

transferAmount for BalanceTransfer

setTransferAmount

public void setTransferAmount(BigDecimal transferAmount)

getForfeitedAmount

public BigDecimal getForfeitedAmount()

Description copied from interface: BalanceTransferContract

The computed amount of accrued leave that will be forfeited

forfeitedAmount of a BalanceTransfer

Specified by:

getForfeitedAmount in interface BalanceTransferContract

Returns:

forfeitedAmount for BalanceTransfer

setForfeitedAmount

public void setForfeitedAmount(BigDecimal forfeitedAmount)

getBalanceTransferId

public String getBalanceTransferId()

Description copied from interface: BalanceTransferContract

The primary key of a BalanceTransfer entry saved in a database

balanceTransferId of a BalanceTransfer

Specified by:

getBalanceTransferId in interface BalanceTransferContract

Returns:

balanceTransferId for BalanceTransfer

setBalanceTransferId

public void setBalanceTransferId(String balanceTransferId)

getAccrualCategoryRule

public String getAccrualCategoryRule()

Description copied from interface: BalanceTransferContract

The AccrualCategoryRule name associated with the BalanceTransfer

accrualCategoryRule of a BalanceTransfer

Specified by:

getAccrualCategoryRule in interface BalanceTransferContract

Returns:

accrualCategoryRule for BalanceTransfer

setAccrualCategoryRule

public void setAccrualCategoryRule(String accrualCategoryRule)

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

getPrincipal

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

Description copied from interface: BalanceTransferContract

The Person object of the user associated with the BalanceTransfer

principal of a BalanceTransfer

Specified by:

getPrincipal in interface BalanceTransferContract

Returns:

principal for BalanceTransfer

setPrincipal

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

getCreditedAccrualCategory

public AccrualCategory getCreditedAccrualCategory()

Description copied from interface: BalanceTransferContract

The AccrualCategory object that the leave is transfered to

AccrualCategory object based on toAccrualCategory

Specified by:

getCreditedAccrualCategory in interface BalanceTransferContract

Returns:

AccrualCategory object based on toAccrualCategory

getDebitedAccrualCategory

public AccrualCategory getDebitedAccrualCategory()

Description copied from interface: BalanceTransferContract

The AccrualCategory object that the leave is transfered from

AccrualCategory object based on fromAccrualCategory

Specified by:

getDebitedAccrualCategory in interface BalanceTransferContract

Returns:

AccrualCategory object based on fromAccrualCategory

getLeaveCalendarDocumentId

public String getLeaveCalendarDocumentId()

Description copied from interface: BalanceTransferContract

The leave calendar document id associated with the BalanceTransfer

leaveCalendarDocumentId of a BalanceTransfer

Specified by:

getLeaveCalendarDocumentId in interface BalanceTransferContract

Returns:

leaveCalendarDocumentId for BalanceTransfer

setLeaveCalendarDocumentId

public void setLeaveCalendarDocumentId(String leaveCalendarDocumentId)

adjust

public BalanceTransfer adjust(BigDecimal transferAmount)

Returns a balance transfer object adjusted for the new transfer amount. "this" must be a default initialized balance transfer. i.e. transfer amount plus forfeited amount equal to the amount of leave in excess of the from accrual category's max balance for the given principal. calling this method without first validating the supplied transfer amount via BalanceTransferValidationUtils may produce undesired results.

Parameters:

transferAmount - The desired transfer amount

Returns:

A balance transfer object with forfeited and amount transfer amounts adjusted to transferAmount

getLeaveBlocks

public List<LeaveBlock> getLeaveBlocks()

Description copied from interface: BalanceTransferContract

The list of LeaveBlock objects associated with the BalanceTransfer

The list contains LeaveBlock objects based on forfeitedLeaveBlockId, accruedLeaveBlockId, and debitedLeaveBlockId

Specified by:

getLeaveBlocks in interface BalanceTransferContract

Returns:

a list of LeaveBlock objects for BalanceTransfer

getStatus

public String getStatus()

Description copied from interface: BalanceTransferContract

The status associated with the BalanceTransfer

status of a BalanceTransfer

Specified by:

getStatus in interface BalanceTransferContract

Returns:

status for BalanceTransfer

setStatus

public void setStatus(String status)

disapprove

public void disapprove()

approve

public void approve()

cancel

public void cancel()

getAccruedLeaveBlockId

public String getAccruedLeaveBlockId()

Description copied from interface: BalanceTransferContract

The accrued leave block id associated with the BalanceTransfer

accruedLeaveBlockId of a BalanceTransfer

Specified by:

getAccruedLeaveBlockId in interface BalanceTransferContract

Returns:

accruedLeaveBlockId for BalanceTransfer

setAccruedLeaveBlockId

public void setAccruedLeaveBlockId(String accruedLeaveBlockId)

getForfeitedLeaveBlockId

public String getForfeitedLeaveBlockId()

Description copied from interface: BalanceTransferContract

The forfeited leave block id associated with the BalanceTransfer

forfeitedLeaveBlockId of a BalanceTransfer

Specified by:

getForfeitedLeaveBlockId in interface BalanceTransferContract

Returns:

forfeitedLeaveBlockId for BalanceTransfer

setForfeitedLeaveBlockId

public void setForfeitedLeaveBlockId(String forfeitedLeaveBlockId)

getDebitedLeaveBlockId

public String getDebitedLeaveBlockId()

Description copied from interface: BalanceTransferContract

The debited leave block id associated with the BalanceTransfer

debitedLeaveBlockId of a BalanceTransfer

Specified by:

getDebitedLeaveBlockId in interface BalanceTransferContract

Returns:

debitedLeaveBlockId for BalanceTransfer

setDebitedLeaveBlockId

public void setDebitedLeaveBlockId(String debitedLeaveBlockId)

getAmountTransferred

public BigDecimal getAmountTransferred()

Description copied from interface: BalanceTransferContract

The amount transfered

amountTransferred of a BalanceTransfer

Specified by:

getAmountTransferred in interface BalanceTransferContract

Returns:

amountTransferred for BalanceTransfer

setAmountTransferred

public void setAmountTransferred(BigDecimal amountTransferrerd)

getSstoId

public String getSstoId()

Description copied from interface: BalanceTransferContract

TODO: Put a better comment

sstoId of a BalanceTransfer

Specified by:

getSstoId in interface BalanceTransferContract

Returns:

sstoId for BalanceTransfer

setSstoId

public void setSstoId(String sstoId)

getDocumentHeaderId

public String getDocumentHeaderId()

Description copied from interface: BalanceTransferContract

The document header id associated with the BalanceTransfer

documentHeaderId of a BalanceTransfer

Specified by:

getDocumentHeaderId in interface BalanceTransferContract

Returns:

documentHeaderId for BalanceTransfer

setDocumentHeaderId

public void setDocumentHeaderId(String documentHeaderId)

getAssignments

public List<Assignment> getAssignments()

Specified by:

getAssignments in interface Assignable