org.kuali.ole.fp.document

Class InternalBillingDocument

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

org.kuali.ole.sys.document.LedgerPostingDocumentBase

org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

org.kuali.ole.sys.document.AccountingDocumentBase

org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

org.kuali.ole.fp.document.InternalBillingDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, CapitalAssetEditable, AccountingDocument, AmountTotaling, Correctable, FinancialSystemDocument, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject, org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

Direct Known Subclasses:

ServiceBillingDocument

public class InternalBillingDocument
extends CapitalAccountingLinesDocumentBase
implements org.kuali.rice.krad.document.Copyable, Correctable, AmountTotaling

This is the business object that represents the InternalBillingDocument in Kuali. This is a transactional document that will eventually post transactions to the G/L. It integrates with workflow and also contains two groupings of accounting lines: Expense and Income.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CapitalAssetManagementModuleService	capitalAssetManagementModuleService
protected List	items
protected Integer	nextItemLineNumber

Fields inherited from class org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

capitalAccountingLines, LOG

Fields inherited from class org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

capitalAssetInformation, nextCapitalAssetLineNumber

Fields inherited from class org.kuali.ole.sys.document.AccountingDocumentBase

dataDictionaryEntry, nextSourceLineNumber, nextTargetLineNumber, sourceAccountingLineClass, sourceAccountingLines, targetAccountingLineClass, targetAccountingLines

Fields inherited from class org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

generalLedgerPendingEntries

Fields inherited from class org.kuali.ole.sys.document.LedgerPostingDocumentBase

accountingPeriod, accountingPeriodService, checkPostingYearForCopy, dataDictionaryService, dateTimeService, postingPeriodCode, postingYear

Fields inherited from class org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

Fields inherited from class org.kuali.rice.krad.document.DocumentBase

documentHeader, documentNumber

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

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
InternalBillingDocument() Initializes the array lists and some basic info.

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(InternalBillingItem item) Adds a new item to the item list.
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent) Override to call super and then iterate over all GLPEs and update the approved code appropriately.
InternalBillingItem	getItem(int index) Retrieve a particular item at a given index in the list of items.
List	getItems()
org.kuali.rice.core.api.util.type.KualiDecimal	getItemTotal() Iterates through the list of items and sums up their totals.
Integer	getNextItemLineNumber() Retrieves the next item line number.
String	getSourceAccountingLinesSectionTitle() This method is used to return the title that a transactional document should give to it's source accounting line section.
String	getTargetAccountingLinesSectionTitle() This method is used to return the title that a transactional document should give to it's source accounting line section.
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) This method determines if an accounting line is a debit accounting line by calling IsDebitUtils.isDebitConsideringSection().
void	postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
void	setItems(List items)
void	setNextItemLineNumber(Integer nextItemLineNumber) Setter for OJB to get from database and JSP to maintain state in hidden fields.

Methods inherited from class org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

getCapitalAccountingLines, setCapitalAccountingLines

Methods inherited from class org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

buildListOfDeletionAwareLists, getCapitalAssetInformation, getNextCapitalAssetLineNumber, setCapitalAssetInformation, setNextCapitalAssetLineNumber

Methods inherited from class org.kuali.ole.sys.document.AccountingDocumentBase

addSourceAccountingLine, addTargetAccountingLine, buildAccountingLineMap, copyAccountingLines, customizeExplicitGeneralLedgerPendingEntry, customizeOffsetGeneralLedgerPendingEntry, generateDocumentGeneralLedgerPendingEntries, generateEvents, generateGeneralLedgerPendingEntries, generateSaveEvents, getAccountingLineParser, getDataDictionaryEntry, getDocumentClassForAccountingLineValueAllowedValidation, getEntryValue, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getNextSourceLineNumber, getNextTargetLineNumber, getPersistedSourceAccountingLinesForComparison, getPersistedTargetAccountingLinesForComparison, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesForComparison, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesForComparison, getTargetTotal, getTotalDollarAmount, isDocumentFinalOrProcessed, prepareForSave, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toCopy, toErrorCorrection, updatePostingYearForAccountingLines

Methods inherited from class org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, documentPerformsSufficientFundsCheck, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, removeGeneralLedgerPendingEntries, setGeneralLedgerPendingEntries

Methods inherited from class org.kuali.ole.sys.document.LedgerPostingDocumentBase

createInitialAccountingPeriod, getAccountingPeriod, getAccountingPeriodCompositeString, getAccountingPeriodService, getDataDictionaryService, getDateTimeService, getFinancialDocumentTypeCode, getPostingPeriodCode, getPostingYear, retrieveCurrentAccountingPeriod, setAccountingPeriod, setAccountingPeriodCompositeString, setPostingPeriodCode, setPostingYear

Methods inherited from class org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

answerSplitNodeQuestion, doRouteLevelChange, getApplicationDocumentStatus, getBusinessObjectService, getFinancialSystemDocumentHeader, getFinancialSystemDocumentService, getParameterService, prepareForSave, processAfterRetrieve, setApplicationDocumentStatus, setDocumentHeader, updateAndSaveAppDocStatus

Methods inherited from class org.kuali.rice.krad.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.krad.document.DocumentBase

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

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

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.document.Copyable

toCopy

Methods inherited from interface org.kuali.ole.sys.document.Correctable

toErrorCorrection

Methods inherited from interface org.kuali.ole.sys.document.AmountTotaling

getTotalDollarAmount

Methods inherited from interface org.kuali.ole.sys.document.GeneralLedgerPostingDocument

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

Methods inherited from interface org.kuali.ole.sys.document.LedgerPostingDocument

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from interface org.kuali.ole.sys.document.FinancialSystemDocument

answerSplitNodeQuestion, getFinancialSystemDocumentHeader

Methods inherited from interface org.kuali.rice.krad.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

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.ole.sys.document.GeneralLedgerPendingEntrySource

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getFinancialSystemDocumentHeader, getPostingYear

Field Detail

items

protected List items

nextItemLineNumber

protected Integer nextItemLineNumber

capitalAssetManagementModuleService

protected transient CapitalAssetManagementModuleService capitalAssetManagementModuleService

Constructor Detail

InternalBillingDocument

public InternalBillingDocument()

Initializes the array lists and some basic info.

Method Detail

isDebit

public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)

This method determines if an accounting line is a debit accounting line by calling IsDebitUtils.isDebitConsideringSection().

Specified by:

isDebit in interface GeneralLedgerPendingEntrySource

Overrides:

isDebit in class CapitalAssetInformationDocumentBase

Parameters:

transactionalDocument - The document containing the accounting line being analyzed.

accountingLine - The accounting line being reviewed to determine if it is a debit line or not.

Returns:

True if the accounting line is a debit accounting line, false otherwise.

See Also:

IsDebitUtils#isDebitConsideringSection(FinancialDocumentRuleBase, FinancialDocument, AccountingLine), org.kuali.rice.krad.rule.AccountingLineRule#isDebit(org.kuali.rice.krad.document.FinancialDocument, org.kuali.rice.krad.bo.AccountingLine)

addItem

public void addItem(InternalBillingItem item)

Adds a new item to the item list.

Parameters:

item -

getItem

public InternalBillingItem getItem(int index)

Retrieve a particular item at a given index in the list of items. For Struts, the requested item and any intervening ones are initialized if necessary.

Parameters:

index -

Returns:

the item

getItems

public List getItems()

Returns:

Returns the items.

getItemTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getItemTotal()

Iterates through the list of items and sums up their totals.

Returns:

the total

getNextItemLineNumber

public Integer getNextItemLineNumber()

Retrieves the next item line number.

Returns:

The next available item line number

setItems

public void setItems(List items)

Parameters:

items -

setNextItemLineNumber

public void setNextItemLineNumber(Integer nextItemLineNumber)

Setter for OJB to get from database and JSP to maintain state in hidden fields. This property is also incremented by the addItem method.

Parameters:

nextItemLineNumber -

getSourceAccountingLinesSectionTitle

public String getSourceAccountingLinesSectionTitle()

Description copied from interface: AccountingDocument

This method is used to return the title that a transactional document should give to it's source accounting line section.

Specified by:

getSourceAccountingLinesSectionTitle in interface AccountingDocument

Overrides:

getSourceAccountingLinesSectionTitle in class AccountingDocumentBase

Returns:

"Income"

See Also:

AccountingDocument.getSourceAccountingLinesSectionTitle()

getTargetAccountingLinesSectionTitle

public String getTargetAccountingLinesSectionTitle()

Description copied from interface: AccountingDocument

This method is used to return the title that a transactional document should give to it's source accounting line section.

Specified by:

getTargetAccountingLinesSectionTitle in interface AccountingDocument

Overrides:

getTargetAccountingLinesSectionTitle in class AccountingDocumentBase

Returns:

"Expense"

See Also:

AccountingDocument.getTargetAccountingLinesSectionTitle()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)

Description copied from class: GeneralLedgerPostingDocumentBase

Override to call super and then iterate over all GLPEs and update the approved code appropriately.

Specified by:

doRouteStatusChange in interface org.kuali.rice.krad.document.Document

Overrides:

doRouteStatusChange in class CapitalAssetInformationDocumentBase

See Also:

org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase#doRouteStatusChange()

postProcessSave

public void postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Specified by:

postProcessSave in interface org.kuali.rice.krad.document.Document

Overrides:

postProcessSave in class org.kuali.rice.krad.document.DocumentBase

See Also:

org.kuali.rice.krad.document.DocumentBase#postProcessSave(org.kuali.rice.krad.rule.event.KualiDocumentEvent)