org.kuali.kfs.gl.businessobject
Class Balance

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BalanceHistory, CashBalance, GlSummary, LedgerBalance

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

This class contains the monthly balance amounts for a specific fiscal year, chart of accounts code, account number, sub account number, object code, sub object code, balance type code, object type code

See Also:

Serialized Form

Field Summary

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

extension, versionNumber

Constructor Summary

Balance()

Balance(BalanceHistory balanceHistory)
Constructs a Balance.java.

Balance(Transaction t)

Method Summary

void	addAmount(String period, org.kuali.rice.kns.util.KualiDecimal amount) Add an amount to a specific period
Account	getAccount() Gets the account attribute.
org.kuali.rice.kns.util.KualiDecimal	getAccountLineAnnualBalanceAmount()
String	getAccountNumber()
org.kuali.rice.kns.util.KualiDecimal	getAmount(String period) Returns an amount for a specific period
BalanceType	getBalanceType() Gets the balanceType attribute.
String	getBalanceTypeCode()
org.kuali.rice.kns.util.KualiDecimal	getBeginningBalanceLineAmount()
Chart	getChart() Gets the chart attribute.
String	getChartOfAccountsCode()
org.kuali.rice.kns.util.KualiDecimal	getCombinedBeginningBalanceAmount()
org.kuali.rice.kns.util.KualiDecimal	getContractsGrantsBeginningBalanceAmount()
TransientBalanceInquiryAttributes	getDummyBusinessObject() Gets the dummyBusinessObject attribute.
ObjectCode	getFinancialObject() Gets the financialObject attribute.
SubObjectCode	getFinancialSubObject() Gets the financialSubObject attribute.
String	getFundGroup() Gets the fundGroup attribute.
org.kuali.rice.kns.util.KualiDecimal	getMonth10Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth11Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth12Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth13Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth1Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth2Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth3Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth4Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth5Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth6Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth7Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth8Amount()
org.kuali.rice.kns.util.KualiDecimal	getMonth9Amount()
String	getObjectCode()
ObjectType	getObjectType() Gets the objectType attribute.
String	getObjectTypeCode()
SystemOptions	getOption()
PriorYearAccount	getPriorYearAccount() Gets the priorYearAccount attribute.
SubAccount	getSubAccount() Gets the subAccount attribute.
String	getSubAccountNumber()
String	getSubObjectCode()
Date	getTimestamp()
Integer	getUniversityFiscalYear()
org.kuali.rice.kns.util.KualiDecimal	getYearBalance() Gets the yearBalance attribute.
org.kuali.rice.kns.util.KualiDecimal	getYearToDayBalance() Gets the yearToDayBalance attribute.
void	setAccount(Account account) Sets the account attribute value.
void	setAccountLineAnnualBalanceAmount(org.kuali.rice.kns.util.KualiDecimal accountLineAnnualBalanceAmount)
void	setAccountNumber(String accountNumber)
void	setBalanceType(BalanceType balanceType) Sets the balanceType attribute value.
void	setBalanceTypeCode(String balanceTypeCode)
void	setBeginningBalanceLineAmount(org.kuali.rice.kns.util.KualiDecimal beginningBalanceLineAmount)
void	setChart(Chart chart) Sets the chart attribute value.
void	setChartOfAccountsCode(String chartOfAccountsCode)
void	setContractsGrantsBeginningBalanceAmount(org.kuali.rice.kns.util.KualiDecimal contractsGrantsBeginningBalanceAmount)
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	setFundGroup(String fundGroup) Sets the fundGroup attribute value.
void	setMonth10Amount(org.kuali.rice.kns.util.KualiDecimal month10Amount)
void	setMonth11Amount(org.kuali.rice.kns.util.KualiDecimal month11Amount)
void	setMonth12Amount(org.kuali.rice.kns.util.KualiDecimal month12Amount)
void	setMonth13Amount(org.kuali.rice.kns.util.KualiDecimal month13Amount)
void	setMonth1Amount(org.kuali.rice.kns.util.KualiDecimal month1Amount)
void	setMonth2Amount(org.kuali.rice.kns.util.KualiDecimal month2Amount)
void	setMonth3Amount(org.kuali.rice.kns.util.KualiDecimal month3Amount)
void	setMonth4Amount(org.kuali.rice.kns.util.KualiDecimal month4Amount)
void	setMonth5Amount(org.kuali.rice.kns.util.KualiDecimal month5Amount)
void	setMonth6Amount(org.kuali.rice.kns.util.KualiDecimal month6Amount)
void	setMonth7Amount(org.kuali.rice.kns.util.KualiDecimal month7Amount)
void	setMonth8Amount(org.kuali.rice.kns.util.KualiDecimal month8Amount)
void	setMonth9Amount(org.kuali.rice.kns.util.KualiDecimal month9Amount)
void	setObjectCode(String objectCode)
void	setObjectType(ObjectType objectType) Sets the objectType attribute value.
void	setObjectTypeCode(String objectTypeCode)
void	setOption(SystemOptions opt)
void	setPriorYearAccount(PriorYearAccount priorYearAccount) Sets the priorYearAccount attribute value.
void	setSubAccount(SubAccount subAccount) Sets the subAccount attribute value.
void	setSubAccountNumber(String subAccountNumber)
void	setSubObjectCode(String subObjectCode)
void	setTimestamp(Date timestamp)
void	setUniversityFiscalYear(Integer universityFiscalYear)
void	setYearBalance(org.kuali.rice.kns.util.KualiDecimal yearBalance) Sets the yearBalance attribute value.
void	setYearToDayBalance(org.kuali.rice.kns.util.KualiDecimal yearToDayBalance) Sets the yearToDayBalance attribute value.
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

Balance

public Balance()

Balance

public Balance(Transaction t)

Balance

public Balance(BalanceHistory balanceHistory)

Constructs a Balance.java.

Parameters:

transaction -

Method Detail

getOption

public SystemOptions getOption()

Returns:

Returns the options.

setOption

public void setOption(SystemOptions opt)

Parameters:

options - The options to set.

toStringMapper

protected LinkedHashMap toStringMapper()

Specified by:

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

getAmount

public org.kuali.rice.kns.util.KualiDecimal getAmount(String period)

Returns an amount for a specific period

Parameters:

period - period to grab amount for

Returns:

KualiDecimal amount for that specific period

addAmount

public void addAmount(String period,
                      org.kuali.rice.kns.util.KualiDecimal amount)

Add an amount to a specific period

Parameters:

period - period to add amount to

amount - amount to add to period

getAccountLineAnnualBalanceAmount

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

Returns:

Returns the accountLineAnnualBalanceAmount.

setAccountLineAnnualBalanceAmount

public void setAccountLineAnnualBalanceAmount(org.kuali.rice.kns.util.KualiDecimal accountLineAnnualBalanceAmount)

Parameters:

accountLineAnnualBalanceAmount - The accountLineAnnualBalanceAmount 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.

getBeginningBalanceLineAmount

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

Returns:

Returns the beginningBalanceLineAmount.

setBeginningBalanceLineAmount

public void setBeginningBalanceLineAmount(org.kuali.rice.kns.util.KualiDecimal beginningBalanceLineAmount)

Parameters:

beginningBalanceLineAmount - The beginningBalanceLineAmount to set.

getChartOfAccountsCode

public String getChartOfAccountsCode()

Returns:

Returns the chartOfAccountsCode.

setChartOfAccountsCode

public void setChartOfAccountsCode(String chartOfAccountsCode)

Parameters:

chartOfAccountsCode - The chartOfAccountsCode to set.

getContractsGrantsBeginningBalanceAmount

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

Returns:

Returns the contractsGrantsBeginningBalanceAmount.

setContractsGrantsBeginningBalanceAmount

public void setContractsGrantsBeginningBalanceAmount(org.kuali.rice.kns.util.KualiDecimal contractsGrantsBeginningBalanceAmount)

Parameters:

contractsGrantsBeginningBalanceAmount - The contractsGrantsBeginningBalanceAmount to set.

getMonth10Amount

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

Returns:

Returns the month10Amount.

setMonth10Amount

public void setMonth10Amount(org.kuali.rice.kns.util.KualiDecimal month10Amount)

Parameters:

month10Amount - The month10Amount to set.

getMonth11Amount

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

Returns:

Returns the month11Amount.

setMonth11Amount

public void setMonth11Amount(org.kuali.rice.kns.util.KualiDecimal month11Amount)

Parameters:

month11Amount - The month11Amount to set.

getMonth12Amount

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

Returns:

Returns the month12Amount.

setMonth12Amount

public void setMonth12Amount(org.kuali.rice.kns.util.KualiDecimal month12Amount)

Parameters:

month12Amount - The month12Amount to set.

getMonth13Amount

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

Returns:

Returns the month13Amount.

setMonth13Amount

public void setMonth13Amount(org.kuali.rice.kns.util.KualiDecimal month13Amount)

Parameters:

month13Amount - The month13Amount to set.

getMonth1Amount

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

Returns:

Returns the month1Amount.

setMonth1Amount

public void setMonth1Amount(org.kuali.rice.kns.util.KualiDecimal month1Amount)

Parameters:

month1Amount - The month1Amount to set.

getMonth2Amount

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

Returns:

Returns the month2Amount.

setMonth2Amount

public void setMonth2Amount(org.kuali.rice.kns.util.KualiDecimal month2Amount)

Parameters:

month2Amount - The month2Amount to set.

getMonth3Amount

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

Returns:

Returns the month3Amount.

setMonth3Amount

public void setMonth3Amount(org.kuali.rice.kns.util.KualiDecimal month3Amount)

Parameters:

month3Amount - The month3Amount to set.

getMonth4Amount

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

Returns:

Returns the month4Amount.

setMonth4Amount

public void setMonth4Amount(org.kuali.rice.kns.util.KualiDecimal month4Amount)

Parameters:

month4Amount - The month4Amount to set.

getMonth5Amount

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

Returns:

Returns the month5Amount.

setMonth5Amount

public void setMonth5Amount(org.kuali.rice.kns.util.KualiDecimal month5Amount)

Parameters:

month5Amount - The month5Amount to set.

getMonth6Amount

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

Returns:

Returns the month6Amount.

setMonth6Amount

public void setMonth6Amount(org.kuali.rice.kns.util.KualiDecimal month6Amount)

Parameters:

month6Amount - The month6Amount to set.

getMonth7Amount

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

Returns:

Returns the month7Amount.

setMonth7Amount

public void setMonth7Amount(org.kuali.rice.kns.util.KualiDecimal month7Amount)

Parameters:

month7Amount - The month7Amount to set.

getMonth8Amount

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

Returns:

Returns the month8Amount.

setMonth8Amount

public void setMonth8Amount(org.kuali.rice.kns.util.KualiDecimal month8Amount)

Parameters:

month8Amount - The month8Amount to set.

getMonth9Amount

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

Returns:

Returns the month9Amount.

setMonth9Amount

public void setMonth9Amount(org.kuali.rice.kns.util.KualiDecimal month9Amount)

Parameters:

month9Amount - The month9Amount to set.

getObjectCode

public String getObjectCode()

Returns:

Returns the objectCode.

setObjectCode

public void setObjectCode(String objectCode)

Parameters:

objectCode - The objectCode to set.

getObjectTypeCode

public String getObjectTypeCode()

Returns:

Returns the objectTypeCode.

setObjectTypeCode

public void setObjectTypeCode(String objectTypeCode)

Parameters:

objectTypeCode - The objectTypeCode 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 Date getTimestamp()

Returns:

Returns the timestamp.

setTimestamp

public void setTimestamp(Date timestamp)

Parameters:

timestamp - The timestamp to set.

getUniversityFiscalYear

public Integer getUniversityFiscalYear()

Returns:

Returns the universityFiscalYear.

setUniversityFiscalYear

public void setUniversityFiscalYear(Integer universityFiscalYear)

Parameters:

universityFiscalYear - The universityFiscalYear 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.

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.

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.

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.

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.

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.

getObjectType

public ObjectType getObjectType()

Gets the objectType attribute.

Returns:

Returns the objectType.

setObjectType

public void setObjectType(ObjectType objectType)

Sets the objectType attribute value.

Parameters:

objectType - The objectType to set.

getPriorYearAccount

public PriorYearAccount getPriorYearAccount()

Gets the priorYearAccount attribute.

Returns:

Returns the priorYearAccount.

setPriorYearAccount

public void setPriorYearAccount(PriorYearAccount priorYearAccount)

Sets the priorYearAccount attribute value.

Parameters:

priorYearAccount - The priorYearAccount to set.

getFundGroup

public String getFundGroup()

Gets the fundGroup attribute.

Returns:

Returns the fundGroup.

setFundGroup

public void setFundGroup(String fundGroup)

Sets the fundGroup attribute value.

Parameters:

fundGroup - The fundGroup to set.

getYearBalance

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

Gets the yearBalance attribute.

Returns:

Returns the yearBalance.

setYearBalance

public void setYearBalance(org.kuali.rice.kns.util.KualiDecimal yearBalance)

Sets the yearBalance attribute value.

Parameters:

yearBalance - The yearBalance to set.

getYearToDayBalance

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

Gets the yearToDayBalance attribute.

Returns:

Returns the yearToDayBalance.

setYearToDayBalance

public void setYearToDayBalance(org.kuali.rice.kns.util.KualiDecimal yearToDayBalance)

Sets the yearToDayBalance attribute value.

Parameters:

yearToDayBalance - The yearToDayBalance to set.

getCombinedBeginningBalanceAmount

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