org.kuali.kfs.sys.businessobject
Interface AccountingLine

All Superinterfaces:

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

All Known Subinterfaces:

BudgetAdjustmentAccountingLine, ExpenseTransferAccountingLine, LaborLedgerExpenseTransferAccountingLine, LaborLedgerExpenseTransferSourceAccountingLine, LaborLedgerExpenseTransferTargetAccountingLine, PurApAccountingLine

All Known Implementing Classes:

AccountingLineBase, AccountsPayableSummaryAccount, AssetPaymentDetail, BudgetAdjustmentSourceAccountingLine, BudgetAdjustmentTargetAccountingLine, CreditMemoAccount, CreditMemoAccountRevision, CustomerInvoiceDetail, ExpenseTransferSourceAccountingLine, ExpenseTransferTargetAccountingLine, GECSourceAccountingLine, GECTargetAccountingLine, LaborJournalVoucherDetail, PaymentRequestAccount, PaymentRequestAccountRevision, ProcurementCardSourceAccountingLine, ProcurementCardTargetAccountingLine, PurApAccountingLineBase, PurchaseOrderAccount, ReceivableCustomerInvoiceDetail, RequisitionAccount, SalesTaxCustomerInvoiceDetail, SourceAccountingLine, TargetAccountingLine, VoucherSourceAccountingLine, WriteoffCustomerInvoiceDetail, WriteoffTaxCustomerInvoiceDetail

public interface AccountingLine
extends org.kuali.rice.kns.bo.PersistableBusinessObject, GeneralLedgerPendingEntrySourceDetail

An AccountLine contains all the accounting items typically necessary to create a pending entry to the G/L. All transaction documents will use this business object inherently. Specific accounting line business rules should exist not in this implementation, but rather in the document business object that uses it.

Method Summary

void	copyFrom(AccountingLine other) Overwrites the fields of this AccountingLine with the values of the corresponding fields of the given AccountingLine.
boolean	getAccountExpiredOverride() This indicates the account expired component of this AccountingLine's overrideCode.
boolean	getAccountExpiredOverrideNeeded() This indicates the account expired override is needed (because this AccountingLine's Account is expired).
String	getAccountKey() Convenience method to make the primitive account fields from this AccountingLine easier to compare to the account fields of another AccountingLine or of an Account
BalanceType	getBalanceTyp()
Chart	getChart()
String	getDebitCreditCode() This method retrieves the debit/credit code for the accounting line.
String	getEncumbranceUpdateCode() This method retrieves the encumbrance update code for the accounting line.
String	getFinancialDocumentLineTypeCode()
boolean	getNonFringeAccountOverride() Gets the nonFringeAccountOverride attribute.
boolean	getNonFringeAccountOverrideNeeded() Gets the nonFringeAccountOverrideNeeded attribute.
ObjectType	getObjectType() This method retrieves the ObjectType for the accounting line.
String	getObjectTypeCode()
String	getOverrideCode()
ProjectCode	getProject()
org.kuali.rice.kew.doctype.bo.DocumentTypeEBO	getReferenceFinancialSystemDocumentTypeCode() Gets the referenceFinancialSystemDocumentTypeCode attribute.
OriginationCode	getReferenceOrigin() This method returns the object related to referenceOriginCode
SalesTax	getSalesTax()
Integer	getSequenceNumber()
SubAccount	getSubAccount()
SubObjectCode	getSubObjectCode()
Map	getValuesMap() Returns a Map with the accounting line primitive field names as the key of the map and the primitive values as the value.
boolean	isLike(AccountingLine other)
boolean	isObjectBudgetOverride() This indicates the object budget component of this AccountingLine's overrideCode.
boolean	isObjectBudgetOverrideNeeded() This indicates the object budget override is needed (because this AccountingLine's Account is expired).
boolean	isSalesTaxRequired() This method checks to see if sales tax is required for this accounting line or not
boolean	isSourceAccountingLine()
boolean	isTargetAccountingLine()
void	setAccount(Account account) Deprecated.
void	setAccountExpiredOverride(boolean b)
void	setAccountExpiredOverrideNeeded(boolean b)
void	setAccountNumber(String accountNumber)
void	setAmount(org.kuali.rice.kns.util.KualiDecimal amount)
void	setBalanceTyp(BalanceType balanceTyp) Deprecated.
void	setBalanceTypeCode(String balanceTypeCode)
void	setChart(Chart chart) Deprecated.
void	setChartOfAccountsCode(String chartOfAccountsCode)
void	setDebitCreditCode(String debitCreditCode) This method sets the debit/credit code for the accounting line.
void	setDocumentNumber(String documentNumber)
void	setEncumbranceUpdateCode(String encumbranceUpdateCode) This method sets the debit/credit code for the accounting line.
void	setFinancialDocumentLineDescription(String financialDocumentLineDescription)
void	setFinancialDocumentLineTypeCode(String financialDocumentLineTypeCode)
void	setFinancialObjectCode(String financialObjectCode)
void	setFinancialSubObjectCode(String financialSubObjectCode)
void	setNonFringeAccountOverride(boolean nonFringeAccountOverride) Sets the nonFringeAccountOverride attribute value.
void	setNonFringeAccountOverrideNeeded(boolean nonFringeAccountOverrideNeeded) Sets the nonFringeAccountOverrideNeeded attribute value.
void	setObjectBudgetOverride(boolean b)
void	setObjectBudgetOverrideNeeded(boolean b)
void	setObjectCode(ObjectCode objectCode) Deprecated.
void	setOrganizationReferenceId(String organizationReferenceId)
void	setOverrideCode(String overrideCode)
void	setPostingYear(Integer postingYear)
void	setProject(ProjectCode project) Deprecated.
void	setProjectCode(String projectCode)
void	setReferenceNumber(String referenceNumber)
void	setReferenceOrigin(OriginationCode referenceOrigin) Deprecated.
void	setReferenceOriginCode(String originCode)
void	setReferenceTypeCode(String referenceTypeCode)
void	setSalesTax(SalesTax salesTax)
void	setSalesTaxRequired(boolean salesTaxRequired) You can set whether or not sales tax is required for this accounting line or not
void	setSequenceNumber(Integer sequenceNumber)
void	setSubAccount(SubAccount subAccount) Deprecated.
void	setSubAccountNumber(String subAccountNumber)
void	setSubObjectCode(SubObjectCode subObjectCode) Deprecated.

Methods inherited from interface org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail

getAccount, getAccountNumber, getAmount, getBalanceTypeCode, getChartOfAccountsCode, getDocumentNumber, getFinancialDocumentLineDescription, getFinancialObjectCode, getFinancialSubObjectCode, getObjectCode, getOrganizationReferenceId, getPostingYear, getProjectCode, getReferenceNumber, getReferenceOriginCode, getReferenceTypeCode, getSubAccountNumber

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

addNote, buildListOfDeletionAwareLists, deleteNote, getBoNote, getBoNotes, getExtension, getObjectId, getVersionNumber, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

prepareForWorkflow, refresh

Methods inherited from interface org.apache.ojb.broker.PersistenceBrokerAware

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate

Method Detail

setAccount

void setAccount(Account account)

Deprecated.

Parameters:

account - The account to set.

getChart

Chart getChart()

Returns:

Returns the chartOfAccountsCode.

setChart

void setChart(Chart chart)

Deprecated.

Parameters:

chart - The chartOfAccountsCode to set.

setAmount

void setAmount(org.kuali.rice.kns.util.KualiDecimal amount)

Parameters:

amount - The amount to set.

getBalanceTyp

BalanceType getBalanceTyp()

Returns:

Returns the balanceTyp.

setBalanceTyp

void setBalanceTyp(BalanceType balanceTyp)

Deprecated.

Parameters:

balanceTyp - The balanceTyp to set.

setObjectCode

void setObjectCode(ObjectCode objectCode)

Deprecated.

Parameters:

objectCode - The objectCode to set.

setReferenceOriginCode

void setReferenceOriginCode(String originCode)

Parameters:

originCode - The referenceOriginCode to set.

getReferenceOrigin

OriginationCode getReferenceOrigin()

This method returns the object related to referenceOriginCode

Returns:

referenceOrigin

setReferenceOrigin

void setReferenceOrigin(OriginationCode referenceOrigin)

Deprecated.

This method sets the referenceOrigin object, this is only to be used by OJB

Parameters:

referenceOrigin -

getReferenceFinancialSystemDocumentTypeCode

org.kuali.rice.kew.doctype.bo.DocumentTypeEBO getReferenceFinancialSystemDocumentTypeCode()

Gets the referenceFinancialSystemDocumentTypeCode attribute.

Returns:

Returns the referenceFinancialSystemDocumentTypeCode.

setOrganizationReferenceId

void setOrganizationReferenceId(String organizationReferenceId)

Parameters:

organizationReferenceId - The organizationReferenceId to set.

getOverrideCode

String getOverrideCode()

Returns:

Returns the overrideCode.

setOverrideCode

void setOverrideCode(String overrideCode)

Parameters:

overrideCode - The overrideCode to set.

setPostingYear

void setPostingYear(Integer postingYear)

Parameters:

postingYear - The postingYear to set.

setProjectCode

void setProjectCode(String projectCode)

Parameters:

projectCode - The projectCode to set.

setReferenceNumber

void setReferenceNumber(String referenceNumber)

Parameters:

referenceNumber - The referenceNumber to set.

setReferenceTypeCode

void setReferenceTypeCode(String referenceTypeCode)

Parameters:

referenceTypeCode - The referenceTypeCode to set.

getSequenceNumber

Integer getSequenceNumber()

Returns:

Returns the sequenceNumber.

setSequenceNumber

void setSequenceNumber(Integer sequenceNumber)

Parameters:

sequenceNumber - The sequenceNumber to set.

getSubAccount

SubAccount getSubAccount()

Returns:

Returns the subAccount.

setSubAccount

void setSubAccount(SubAccount subAccount)

Deprecated.

Parameters:

subAccount - The subAccount to set.

getSubObjectCode

SubObjectCode getSubObjectCode()

Returns:

Returns the subObjectCode.

setSubObjectCode

void setSubObjectCode(SubObjectCode subObjectCode)

Deprecated.

Parameters:

subObjectCode - The subObjectCode to set.

setDocumentNumber

void setDocumentNumber(String documentNumber)

Parameters:

documentNumber - The documentNumber to set.

getDebitCreditCode

String getDebitCreditCode()

This method retrieves the debit/credit code for the accounting line. This method will only return a not null value for a Journal Voucher document.

Returns:

A String code.

setDebitCreditCode

void setDebitCreditCode(String debitCreditCode)

This method sets the debit/credit code for the accounting line. This method should only be used for a Journal Voucher document.

Parameters:

debitCreditCode -

getEncumbranceUpdateCode

String getEncumbranceUpdateCode()

This method retrieves the encumbrance update code for the accounting line. This method will only return a not null value for a Journal Voucher document.

Returns:

A String code.

setEncumbranceUpdateCode

void setEncumbranceUpdateCode(String encumbranceUpdateCode)

This method sets the debit/credit code for the accounting line. This method should only be used for a Journal Voucher document.

Parameters:

encumbranceUpdateCode -

getObjectType

ObjectType getObjectType()

This method retrieves the ObjectType for the accounting line. This method will only return a not null value for a Journal Voucher document.

Returns:

An ObjectType instance.

setAccountNumber

void setAccountNumber(String accountNumber)

Parameters:

accountNumber - The accountNumber to set.

setBalanceTypeCode

void setBalanceTypeCode(String balanceTypeCode)

Parameters:

balanceTypeCode - The balanceTypeCode to set.

setChartOfAccountsCode

void setChartOfAccountsCode(String chartOfAccountsCode)

Parameters:

chartOfAccountsCode - The chartOfAccountsCode to set.

setFinancialObjectCode

void setFinancialObjectCode(String financialObjectCode)

Parameters:

financialObjectCode - The financialObjectCode to set.

setFinancialSubObjectCode

void setFinancialSubObjectCode(String financialSubObjectCode)

Parameters:

financialSubObjectCode - The financialSubObjectCode to set.

getObjectTypeCode

String getObjectTypeCode()

Returns:

Returns the objectTypeCode.

getFinancialDocumentLineTypeCode

String getFinancialDocumentLineTypeCode()

Returns:

Returns the financialDocumentLineTypeCode.

setFinancialDocumentLineTypeCode

void setFinancialDocumentLineTypeCode(String financialDocumentLineTypeCode)

Parameters:

financialDocumentLineTypeCode - The financialDocumentLineTypeCode to set.

getProject

ProjectCode getProject()

Returns:

Returns the project.

setProject

void setProject(ProjectCode project)

Deprecated.

Parameters:

project - The project to set.

setSubAccountNumber

void setSubAccountNumber(String subAccountNumber)

Parameters:

subAccountNumber - The subAccountNumber to set.

setFinancialDocumentLineDescription

void setFinancialDocumentLineDescription(String financialDocumentLineDescription)

Parameters:

financialDocumentLineDescription - The financialDocumentLineDescription to set.

getSalesTax

SalesTax getSalesTax()

Returns:

the sales tax associated with this line if any

setSalesTax

void setSalesTax(SalesTax salesTax)

Parameters:

salesTax - The sales tax associated with this AccountingLine

isSalesTaxRequired

boolean isSalesTaxRequired()

This method checks to see if sales tax is required for this accounting line or not

Returns:

true if it is required, false otherwise

setSalesTaxRequired

void setSalesTaxRequired(boolean salesTaxRequired)

You can set whether or not sales tax is required for this accounting line or not

Parameters:

salesTaxRequired - - true if required

isSourceAccountingLine

boolean isSourceAccountingLine()

See Also:

org.kuali.rice.kns.bo.AccountingLine#isSourceAccountingLine()

isTargetAccountingLine

boolean isTargetAccountingLine()

See Also:

org.kuali.rice.kns.bo.AccountingLine#isTargetAccountingLine()

isLike

boolean isLike(AccountingLine other)

Parameters:

other -

Returns:

true if this AccountingLine has the same primitive field values as the given one

copyFrom

void copyFrom(AccountingLine other)

Overwrites the fields of this AccountingLine with the values of the corresponding fields of the given AccountingLine. Reference field values are in this instance are overwritten with deepCopies of the reference fields of the given AccountingLine.

Parameters:

other -

getAccountKey

String getAccountKey()

Convenience method to make the primitive account fields from this AccountingLine easier to compare to the account fields of another AccountingLine or of an Account

Returns:

String representing the account associated with this AccountingLine

getAccountExpiredOverride

boolean getAccountExpiredOverride()

This indicates the account expired component of this AccountingLine's overrideCode. It provides a DataDictionary attribute for the UI, but is not persisted itself.

Returns:

accountExpiredOverride

setAccountExpiredOverride

void setAccountExpiredOverride(boolean b)

Parameters:

b - the accountExpiredOverride to set

See Also:

getAccountExpiredOverride()

getAccountExpiredOverrideNeeded

boolean getAccountExpiredOverrideNeeded()

This indicates the account expired override is needed (because this AccountingLine's Account is expired). It tells the UI to display the accountExpiredOverride attribute, but is not persisted itself.

Returns:

accountExpiredOverride

setAccountExpiredOverrideNeeded

void setAccountExpiredOverrideNeeded(boolean b)

Parameters:

b - the accountExpiredOverrideNeeded to set

See Also:

getAccountExpiredOverrideNeeded()

isObjectBudgetOverride

boolean isObjectBudgetOverride()

This indicates the object budget component of this AccountingLine's overrideCode. It provides a DataDictionary attribute for the UI, but is not persisted itself.

Returns:

objectBudgetOverride

setObjectBudgetOverride

void setObjectBudgetOverride(boolean b)

Parameters:

b - the objectBudgetOverride to set

See Also:

isObjectBudgetOverride()

isObjectBudgetOverrideNeeded

boolean isObjectBudgetOverrideNeeded()

This indicates the object budget override is needed (because this AccountingLine's Account is expired). It tells the UI to display the objectBudgetOverride attribute, but is not persisted itself.

Returns:

boolean

setObjectBudgetOverrideNeeded

void setObjectBudgetOverrideNeeded(boolean b)

Parameters:

b - the objectBudgetOverride to set

See Also:

isObjectBudgetOverrideNeeded()

getNonFringeAccountOverride

boolean getNonFringeAccountOverride()

Gets the nonFringeAccountOverride attribute.

Returns:

Returns the nonFringeAccountOverride.

setNonFringeAccountOverride

void setNonFringeAccountOverride(boolean nonFringeAccountOverride)

Sets the nonFringeAccountOverride attribute value.

Parameters:

nonFringeAccountOverride - The nonFringeAccountOverride to set.

getNonFringeAccountOverrideNeeded

boolean getNonFringeAccountOverrideNeeded()

Gets the nonFringeAccountOverrideNeeded attribute.

Returns:

Returns the nonFringeAccountOverrideNeeded.

setNonFringeAccountOverrideNeeded

void setNonFringeAccountOverrideNeeded(boolean nonFringeAccountOverrideNeeded)

Sets the nonFringeAccountOverrideNeeded attribute value.

Parameters:

nonFringeAccountOverrideNeeded - The nonFringeAccountOverrideNeeded to set.

getValuesMap

Map getValuesMap()

Returns a Map with the accounting line primitive field names as the key of the map and the primitive values as the value.

Returns:

Map