org.kuali.kfs.gl.businessobject
Class Encumbrance

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.kfs.gl.businessobject.Encumbrance

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject

Direct Known Subclasses:

EncumbranceHistory

public class Encumbrance
extends org.kuali.rice.kns.bo.PersistableBusinessObjectBase

Represents the encumbrance amount for a specific university fiscal year, chart of accounts code, account number, sub account number, object code, sub object code, balance type code, document type code, origin code, and document number. This encumbrance object contains amounts for actual enumbrance amount, closed amount, outstanding amount

See Also:

Serialized Form

Field Summary

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

extension, versionNumber

Constructor Summary

Encumbrance()

Encumbrance(EncumbranceHistory encumbranceHistory)
Constructs a AccountBalance.java per the primary keys only of the passed in accountBalanceHistory

Encumbrance(Transaction t)

Method Summary

Account	getAccount() Gets the account attribute.
org.kuali.rice.kns.util.KualiDecimal	getAccountLineEncumbranceAmount()
org.kuali.rice.kns.util.KualiDecimal	getAccountLineEncumbranceClosedAmount()
org.kuali.rice.kns.util.KualiDecimal	getAccountLineEncumbranceOutstandingAmount()
String	getAccountLineEncumbrancePurgeCode()
String	getAccountNumber()
BalanceType	getBalanceType() Gets the balanceType attribute.
String	getBalanceTypeCode()
Chart	getChart() Gets the chart attribute.
String	getChartOfAccountsCode()
String	getDocumentNumber()
String	getDocumentTypeCode()
TransientBalanceInquiryAttributes	getDummyBusinessObject() Gets the dummyBusinessObject attribute.
ObjectCode	getFinancialObject() Gets the financialObject attribute.
SubObjectCode	getFinancialSubObject() Gets the financialSubObject attribute.
org.kuali.rice.kew.doctype.bo.DocumentTypeEBO	getFinancialSystemDocumentTypeCode() Gets the financialSystemDocumentTypeCode attribute.
String	getObjectCode()
SystemOptions	getOption() Gets the option attribute.
OriginationCode	getOriginationCode()
String	getOriginCode()
SubAccount	getSubAccount() Gets the subAccount attribute.
String	getSubAccountNumber()
String	getSubObjectCode()
Timestamp	getTimestamp()
Date	getTransactionEncumbranceDate()
String	getTransactionEncumbranceDescription()
Integer	getUniversityFiscalYear()
void	setAccount(Account account) Sets the account attribute value.
void	setAccountLineEncumbranceAmount(org.kuali.rice.kns.util.KualiDecimal accountLineEncumbranceAmount)
void	setAccountLineEncumbranceClosedAmount(org.kuali.rice.kns.util.KualiDecimal accountLineEncumbranceClosedAmount)
void	setAccountLineEncumbranceOutstandingAmount()
void	setAccountLineEncumbrancePurgeCode(String accountLineEncumbrancePurgeCode)
void	setAccountNumber(String accountNumber)
void	setBalanceType(BalanceType balanceType) Sets the balanceType attribute value.
void	setBalanceTypeCode(String balanceTypeCode)
void	setChart(Chart chart) Sets the chart attribute value.
void	setChartOfAccountsCode(String chartOfAccountsCode)
void	setDocumentNumber(String documentNumber)
void	setDocumentTypeCode(String documentTypeCode)
void	setDummyBusinessObject(TransientBalanceInquiryAttributes dummyBusinessObject) Sets the dummyBusinessObject attribute value.
void	setFinancialObject(ObjectCode financialObject) Sets the financialObject attribute value.
void	setFinancialSubObject(SubObjectCode financialSubObject) Sets the financialSubObject attribute value.
void	setObjectCode(String objectCode)
void	setOption(SystemOptions option) Sets the option attribute value.
void	setOriginationCode(OriginationCode originationCode)
void	setOriginCode(String originCode)
void	setSubAccount(SubAccount subAccount) Sets the subAccount attribute value.
void	setSubAccountNumber(String subAccountNumber)
void	setSubObjectCode(String subObjectCode)
void	setTimestamp(Timestamp timestamp)
void	setTransactionEncumbranceDate(Date transactionEncumbranceDate)
void	setTransactionEncumbranceDescription(String transactionEncumbranceDescription)
void	setUniversityFiscalYear(Integer universityFiscalYear)
protected LinkedHashMap	toStringMapper()

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

addNote, afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes

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

prepareForWorkflow, toString, toStringBuilder

Methods inherited from class java.lang.Object

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

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

prepareForWorkflow

Constructor Detail

Encumbrance

public Encumbrance()

Encumbrance

public Encumbrance(Transaction t)

Encumbrance

public Encumbrance(EncumbranceHistory encumbranceHistory)

Constructs a AccountBalance.java per the primary keys only of the passed in accountBalanceHistory

Parameters:

accountBalanceHistory -

Method Detail

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

toStringMapper in class org.kuali.rice.kns.bo.BusinessObjectBase

getOriginationCode

public OriginationCode getOriginationCode()

setOriginationCode

public void setOriginationCode(OriginationCode originationCode)

getAccountLineEncumbranceAmount

public org.kuali.rice.kns.util.KualiDecimal getAccountLineEncumbranceAmount()

Returns:

Returns the accountLineEncumbranceAmount.

setAccountLineEncumbranceAmount

public void setAccountLineEncumbranceAmount(org.kuali.rice.kns.util.KualiDecimal accountLineEncumbranceAmount)

Parameters:

accountLineEncumbranceAmount - The accountLineEncumbranceAmount to set.

getAccountLineEncumbranceClosedAmount

public org.kuali.rice.kns.util.KualiDecimal getAccountLineEncumbranceClosedAmount()

Returns:

Returns the accountLineEncumbranceClearedAmount.

setAccountLineEncumbranceOutstandingAmount

public void setAccountLineEncumbranceOutstandingAmount()

getAccountLineEncumbranceOutstandingAmount

public org.kuali.rice.kns.util.KualiDecimal getAccountLineEncumbranceOutstandingAmount()

setAccountLineEncumbranceClosedAmount

public void setAccountLineEncumbranceClosedAmount(org.kuali.rice.kns.util.KualiDecimal accountLineEncumbranceClosedAmount)

Parameters:

accountLineEncumbranceClearedAmount - The accountLineEncumbranceClearedAmount to set.

getAccountLineEncumbrancePurgeCode

public String getAccountLineEncumbrancePurgeCode()

Returns:

Returns the accountLineEncumbrancePrg.

setAccountLineEncumbrancePurgeCode

public void setAccountLineEncumbrancePurgeCode(String accountLineEncumbrancePurgeCode)

Parameters:

accountLineEncumbrancePrg - The accountLineEncumbrancePrg to set.

getAccountNumber

public String getAccountNumber()

Returns:

Returns the accountNumber.

setAccountNumber

public void setAccountNumber(String accountNumber)

Parameters:

accountNumber - The accountNumber to set.

getBalanceTypeCode

public String getBalanceTypeCode()

Returns:

Returns the balanceTypeCode.

setBalanceTypeCode

public void setBalanceTypeCode(String balanceTypeCode)

Parameters:

balanceTypeCode - The balanceTypeCode to set.

getChartOfAccountsCode

public String getChartOfAccountsCode()

Returns:

Returns the chartOfAccountsCode.

setChartOfAccountsCode

public void setChartOfAccountsCode(String chartOfAccountsCode)

Parameters:

chartOfAccountsCode - The chartOfAccountsCode to set.

getDocumentNumber

public String getDocumentNumber()

Returns:

Returns the documentNumber.

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Parameters:

documentNumber - The documentNumber to set.

getDocumentTypeCode

public String getDocumentTypeCode()

Returns:

Returns the documentTypeCode.

setDocumentTypeCode

public void setDocumentTypeCode(String documentTypeCode)

Parameters:

documentTypeCode - The documentTypeCode to set.

getObjectCode

public String getObjectCode()

Returns:

Returns the objectCode.

setObjectCode

public void setObjectCode(String objectCode)

Parameters:

objectCode - The objectCode to set.

getOriginCode

public String getOriginCode()

Returns:

Returns the originCode.

setOriginCode

public void setOriginCode(String originCode)

Parameters:

originCode - The originCode to set.

getSubAccountNumber

public String getSubAccountNumber()

Returns:

Returns the subAccountNumber.

setSubAccountNumber

public void setSubAccountNumber(String subAccountNumber)

Parameters:

subAccountNumber - The subAccountNumber to set.

getSubObjectCode

public String getSubObjectCode()

Returns:

Returns the subObjectCode.

setSubObjectCode

public void setSubObjectCode(String subObjectCode)

Parameters:

subObjectCode - The subObjectCode to set.

getTimestamp

public Timestamp getTimestamp()

Returns:

Returns the timestamp.

setTimestamp

public void setTimestamp(Timestamp timestamp)

Parameters:

timestamp - The timestamp to set.

getTransactionEncumbranceDate

public Date getTransactionEncumbranceDate()

Returns:

Returns the transactionEncumbranceDate.

setTransactionEncumbranceDate

public void setTransactionEncumbranceDate(Date transactionEncumbranceDate)

Parameters:

transactionEncumbranceDate - The transactionEncumbranceDate to set.

getTransactionEncumbranceDescription

public String getTransactionEncumbranceDescription()

Returns:

Returns the transactionEncumbranceDescription.

setTransactionEncumbranceDescription

public void setTransactionEncumbranceDescription(String transactionEncumbranceDescription)

Parameters:

transactionEncumbranceDescription - The transactionEncumbranceDescription to set.

getUniversityFiscalYear

public Integer getUniversityFiscalYear()

Returns:

Returns the universityFiscalYear.

setUniversityFiscalYear

public void setUniversityFiscalYear(Integer universityFiscalYear)

Parameters:

universityFiscalYear - The universityFiscalYear to set.

getAccount

public Account getAccount()

Gets the account attribute.

Returns:

Returns the account.

setAccount

public void setAccount(Account account)

Sets the account attribute value.

Parameters:

account - The account to set.

getChart

public Chart getChart()

Gets the chart attribute.

Returns:

Returns the chart.

setChart

public void setChart(Chart chart)

Sets the chart attribute value.

Parameters:

chart - The chart to set.

getFinancialObject

public ObjectCode getFinancialObject()

Gets the financialObject attribute.

Returns:

Returns the financialObject.

setFinancialObject

public void setFinancialObject(ObjectCode financialObject)

Sets the financialObject attribute value.

Parameters:

financialObject - The financialObject to set.

getBalanceType

public BalanceType getBalanceType()

Gets the balanceType attribute.

Returns:

Returns the balanceType.

setBalanceType

public void setBalanceType(BalanceType balanceType)

Sets the balanceType attribute value.

Parameters:

balanceType - The balanceType to set.

getDummyBusinessObject

public TransientBalanceInquiryAttributes getDummyBusinessObject()

Gets the dummyBusinessObject attribute.

Returns:

Returns the dummyBusinessObject.

setDummyBusinessObject

public void setDummyBusinessObject(TransientBalanceInquiryAttributes dummyBusinessObject)

Sets the dummyBusinessObject attribute value.

Parameters:

dummyBusinessObject - The dummyBusinessObject to set.

getOption

public SystemOptions getOption()

Gets the option attribute.

Returns:

Returns the option.

setOption

public void setOption(SystemOptions option)

Sets the option attribute value.

Parameters:

option - The option to set.

getSubAccount

public SubAccount getSubAccount()

Gets the subAccount attribute.

Returns:

Returns the subAccount.

setSubAccount

public void setSubAccount(SubAccount subAccount)

Sets the subAccount attribute value.

Parameters:

subAccount - The subAccount to set.

getFinancialSystemDocumentTypeCode

public org.kuali.rice.kew.doctype.bo.DocumentTypeEBO getFinancialSystemDocumentTypeCode()

Gets the financialSystemDocumentTypeCode attribute.

Returns:

Returns the financialSystemDocumentTypeCode.

getFinancialSubObject

public SubObjectCode getFinancialSubObject()

Gets the financialSubObject attribute.

Returns:

Returns the financialSubObject.

setFinancialSubObject

public void setFinancialSubObject(SubObjectCode financialSubObject)

Sets the financialSubObject attribute value.

Parameters:

financialSubObject - The financialSubObject to set.