org.kuali.kfs.gl.businessobject
Class LedgerEntry

java.lang.Object
  org.kuali.kfs.gl.businessobject.LedgerEntry

public class LedgerEntry
extends Object

A representation of LedgerEntries, which are summaries that show up on Ledger Reports created by the scrubber and poster.

Constructor Summary

LedgerEntry()
Constructs a LedgerEntry.java.

LedgerEntry(Integer fiscalYear, String period, String balanceType, String originCode)
Constructs a LedgerEntry.java.

LedgerEntry(Integer fiscalYear, String period, String balanceType, String originCode, String debitCreditCode, org.kuali.rice.kns.util.KualiDecimal amount, int count)
Constructs a LedgerEntry.java.

Method Summary

void	add(LedgerEntry addend) Add the amounts of the given ledger entry into those of current ledger entry, and update the counts of corresponding fields
static LedgerEntry	buildLedgerEntry(Object[] entrySummary) create or update a ledger entry with the array of information from the given entry summary object
String	getBalanceType() Gets the balanceType attribute.
org.kuali.rice.kns.util.KualiDecimal	getCreditAmount() Gets the creditAmount attribute.
int	getCreditCount() Gets the creditCount attribute.
org.kuali.rice.kns.util.KualiDecimal	getDebitAmount() Gets the debitAmount attribute.
int	getDebitCount() Gets the debitCount attribute.
Integer	getFiscalYear() Gets the fiscalYear attribute.
org.kuali.rice.kns.util.KualiDecimal	getNoDCAmount() Gets the noDCAmount attribute.
int	getNoDCCount() Gets the noDCCount attribute.
String	getOriginCode() Gets the originCode attribute.
String	getPeriod() Gets the period attribute.
int	getRecordCount() Gets the recordCount attribute.
void	setBalanceType(String balanceType) Sets the balanceType attribute value.
void	setCreditAmount(org.kuali.rice.kns.util.KualiDecimal creditAmount) Sets the creditAmount attribute value.
void	setCreditCount(int creditCount) Sets the creditCount attribute value.
void	setDebitAmount(org.kuali.rice.kns.util.KualiDecimal debitAmount) Sets the debitAmount attribute value.
void	setDebitCount(int debitCount) Sets the debitCount attribute value.
void	setFiscalYear(Integer fiscalYear) Sets the fiscalYear attribute value.
void	setNoDCAmount(org.kuali.rice.kns.util.KualiDecimal noDCAmount) Sets the noDCAmount attribute value.
void	setNoDCCount(int noDCCount) Sets the noDCCount attribute value.
void	setOriginCode(String originCode) Sets the originCode attribute value.
void	setPeriod(String period) Sets the period attribute value.
void	setRecordCount(int recordCount) Sets the recordCount attribute value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LedgerEntry

public LedgerEntry()

Constructs a LedgerEntry.java.

LedgerEntry

public LedgerEntry(Integer fiscalYear,
                   String period,
                   String balanceType,
                   String originCode)

Constructs a LedgerEntry.java.

Parameters:

fiscalYear -

period -

balanceType -

originCode -

LedgerEntry

public LedgerEntry(Integer fiscalYear,
                   String period,
                   String balanceType,
                   String originCode,
                   String debitCreditCode,
                   org.kuali.rice.kns.util.KualiDecimal amount,
                   int count)

Constructs a LedgerEntry.java.

Parameters:

fiscalYear -

period -

balanceType -

originCode -

debitCreditCode -

amount -

count -

Method Detail

add

public void add(LedgerEntry addend)

Add the amounts of the given ledger entry into those of current ledger entry, and update the counts of corresponding fields

Parameters:

addend - the given ledger entry to be added into current one

buildLedgerEntry

public static LedgerEntry buildLedgerEntry(Object[] entrySummary)

create or update a ledger entry with the array of information from the given entry summary object

Parameters:

entrySummary - an entry summary to turn into a ledger entry

Returns:

a LedgerEntry created from the entrySummary array

getBalanceType

public String getBalanceType()

Gets the balanceType attribute.

Returns:

Returns the balanceType.

setBalanceType

public void setBalanceType(String balanceType)

Sets the balanceType attribute value.

Parameters:

balanceType - The balanceType to set.

getCreditAmount

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

Gets the creditAmount attribute.

Returns:

Returns the creditAmount.

setCreditAmount

public void setCreditAmount(org.kuali.rice.kns.util.KualiDecimal creditAmount)

Sets the creditAmount attribute value.

Parameters:

creditAmount - The creditAmount to set.

getCreditCount

public int getCreditCount()

Gets the creditCount attribute.

Returns:

Returns the creditCount.

setCreditCount

public void setCreditCount(int creditCount)

Sets the creditCount attribute value.

Parameters:

creditCount - The creditCount to set.

getDebitAmount

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

Gets the debitAmount attribute.

Returns:

Returns the debitAmount.

setDebitAmount

public void setDebitAmount(org.kuali.rice.kns.util.KualiDecimal debitAmount)

Sets the debitAmount attribute value.

Parameters:

debitAmount - The debitAmount to set.

getDebitCount

public int getDebitCount()

Gets the debitCount attribute.

Returns:

Returns the debitCount.

setDebitCount

public void setDebitCount(int debitCount)

Sets the debitCount attribute value.

Parameters:

debitCount - The debitCount to set.

getFiscalYear

public Integer getFiscalYear()

Gets the fiscalYear attribute.

Returns:

Returns the fiscalYear.

setFiscalYear

public void setFiscalYear(Integer fiscalYear)

Sets the fiscalYear attribute value.

Parameters:

fiscalYear - The fiscalYear to set.

getNoDCAmount

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

Gets the noDCAmount attribute.

Returns:

Returns the noDCAmount.

setNoDCAmount

public void setNoDCAmount(org.kuali.rice.kns.util.KualiDecimal noDCAmount)

Sets the noDCAmount attribute value.

Parameters:

noDCAmount - The noDCAmount to set.

getNoDCCount

public int getNoDCCount()

Gets the noDCCount attribute.

Returns:

Returns the noDCCount.

setNoDCCount

public void setNoDCCount(int noDCCount)

Sets the noDCCount attribute value.

Parameters:

noDCCount - The noDCCount to set.

getOriginCode

public String getOriginCode()

Gets the originCode attribute.

Returns:

Returns the originCode.

setOriginCode

public void setOriginCode(String originCode)

Sets the originCode attribute value.

Parameters:

originCode - The originCode to set.

getPeriod

public String getPeriod()

Gets the period attribute.

Returns:

Returns the period.

setPeriod

public void setPeriod(String period)

Sets the period attribute value.

Parameters:

period - The period to set.

getRecordCount

public int getRecordCount()

Gets the recordCount attribute.

Returns:

Returns the recordCount.

setRecordCount

public void setRecordCount(int recordCount)

Sets the recordCount attribute value.

Parameters:

recordCount - The recordCount to set.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()