org.kuali.kpme.tklm.api.leave.transfer

Interface BalanceTransferContract

All Superinterfaces:

org.kuali.rice.krad.bo.BusinessObject, CreateTime, Effective, org.kuali.rice.core.api.mo.common.GloballyUnique, HrBusinessObjectContract, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.active.Inactivatable, KpmeDataTransferObject, KpmeEffectiveDataTransferObject, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.PersistableBusinessObject, Serializable, UserModified, org.kuali.rice.core.api.mo.common.Versioned

All Known Implementing Classes:

BalanceTransfer

public interface BalanceTransferContract
extends HrBusinessObjectContract

BalanceTransferContract interface.

Method Summary

Methods

Modifier and Type	Method and Description
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
String	getBalanceTransferId() The primary key of a BalanceTransfer entry saved in a database
AccrualCategoryContract	getCreditedAccrualCategory() The AccrualCategory object that the leave is transfered to
AccrualCategoryContract	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
List<? extends LeaveBlockContract>	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

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

areAllBusinessKeyValuesAvailable, getBusinessKeyValuesMap, getEffectiveDate, 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

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

getId

Methods inherited from interface org.kuali.kpme.core.api.mo.Effective

getEffectiveLocalDate

Methods inherited from interface org.kuali.kpme.core.api.mo.CreateTime

getCreateTime

Methods inherited from interface org.kuali.kpme.core.api.mo.UserModified

getUserPrincipalId

Method Detail

getPrincipalId

String getPrincipalId()

The principalId of the user associated with the BalanceTransfer

principalId of a BalanceTransfer

Returns:

principalId for BalanceTransfer

getToAccrualCategory

String getToAccrualCategory()

The AccrualCategory name that the leave is transfered to

toAccrualCategory of a BalanceTransfer

Returns:

toAccrualCategory for BalanceTransfer

getFromAccrualCategory

String getFromAccrualCategory()

The AccrualCategory name that the leave is transfered from

fromAccrualCategory of a BalanceTransfer

Returns:

fromAccrualCategory for BalanceTransfer

getTransferAmount

BigDecimal getTransferAmount()

The amount of accrued leave to transfer

transferAmount of a BalanceTransfer

Returns:

transferAmount for BalanceTransfer

getForfeitedAmount

BigDecimal getForfeitedAmount()

The computed amount of accrued leave that will be forfeited

forfeitedAmount of a BalanceTransfer

Returns:

forfeitedAmount for BalanceTransfer

getBalanceTransferId

String getBalanceTransferId()

The primary key of a BalanceTransfer entry saved in a database

balanceTransferId of a BalanceTransfer

Returns:

balanceTransferId for BalanceTransfer

getAccrualCategoryRule

String getAccrualCategoryRule()

The AccrualCategoryRule name associated with the BalanceTransfer

accrualCategoryRule of a BalanceTransfer

Returns:

accrualCategoryRule for BalanceTransfer

getPrincipal

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

The Person object of the user associated with the BalanceTransfer

principal of a BalanceTransfer

Returns:

principal for BalanceTransfer

getCreditedAccrualCategory

AccrualCategoryContract getCreditedAccrualCategory()

The AccrualCategory object that the leave is transfered to

AccrualCategory object based on toAccrualCategory

Returns:

AccrualCategory object based on toAccrualCategory

getDebitedAccrualCategory

AccrualCategoryContract getDebitedAccrualCategory()

The AccrualCategory object that the leave is transfered from

AccrualCategory object based on fromAccrualCategory

Returns:

AccrualCategory object based on fromAccrualCategory

getLeaveCalendarDocumentId

String getLeaveCalendarDocumentId()

The leave calendar document id associated with the BalanceTransfer

leaveCalendarDocumentId of a BalanceTransfer

Returns:

leaveCalendarDocumentId for BalanceTransfer

getLeaveBlocks

List<? extends LeaveBlockContract> getLeaveBlocks()

The list of LeaveBlock objects associated with the BalanceTransfer

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

Returns:

a list of LeaveBlock objects for BalanceTransfer

getStatus

String getStatus()

The status associated with the BalanceTransfer

status of a BalanceTransfer

Returns:

status for BalanceTransfer

getAccruedLeaveBlockId

String getAccruedLeaveBlockId()

The accrued leave block id associated with the BalanceTransfer

accruedLeaveBlockId of a BalanceTransfer

Returns:

accruedLeaveBlockId for BalanceTransfer

getForfeitedLeaveBlockId

String getForfeitedLeaveBlockId()

The forfeited leave block id associated with the BalanceTransfer

forfeitedLeaveBlockId of a BalanceTransfer

Returns:

forfeitedLeaveBlockId for BalanceTransfer

getDebitedLeaveBlockId

String getDebitedLeaveBlockId()

The debited leave block id associated with the BalanceTransfer

debitedLeaveBlockId of a BalanceTransfer

Returns:

debitedLeaveBlockId for BalanceTransfer

getAmountTransferred

BigDecimal getAmountTransferred()

The amount transfered

amountTransferred of a BalanceTransfer

Returns:

amountTransferred for BalanceTransfer

getSstoId

String getSstoId()

TODO: Put a better comment

sstoId of a BalanceTransfer

Returns:

sstoId for BalanceTransfer

getDocumentHeaderId

String getDocumentHeaderId()

The document header id associated with the BalanceTransfer

documentHeaderId of a BalanceTransfer

Returns:

documentHeaderId for BalanceTransfer