org.kuali.kfs.module.ar.document
Class CustomerInvoiceDocument

java.lang.Object
  org.kuali.rice.kns.bo.BusinessObjectBase
      org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          org.kuali.rice.kns.document.DocumentBase
              org.kuali.rice.kns.document.TransactionalDocumentBase
                  org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
                      org.kuali.kfs.sys.document.LedgerPostingDocumentBase
                          org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase
                              org.kuali.kfs.sys.document.AccountingDocumentBase
                                  org.kuali.kfs.module.ar.document.CustomerInvoiceDocument

All Implemented Interfaces:

Serializable, Comparable<CustomerInvoiceDocument>, org.apache.ojb.broker.PersistenceBrokerAware, AccountingDocument, AmountTotaling, Correctable, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject, org.kuali.rice.kns.document.Copyable, org.kuali.rice.kns.document.Document, org.kuali.rice.kns.document.SessionDocument, org.kuali.rice.kns.document.TransactionalDocument

public class CustomerInvoiceDocument
extends AccountingDocumentBase
implements AmountTotaling, org.kuali.rice.kns.document.Copyable, Correctable, Comparable<CustomerInvoiceDocument>

Author:

Kuali Nervous System Team (kualidev@oncourse.iu.edu)

See Also:

Serialized Form

Field Summary

protected AccountsReceivableDocumentHeader	accountsReceivableDocumentHeader
protected Integer	age
protected static String	BATCH_GENERATED_NODE
protected Chart	billByChartOfAccount
protected String	billByChartOfAccountCode
protected Organization	billedByOrganization
protected String	billedByOrganizationCode
protected String	billingAddressInternationalProvinceName
protected String	billingAddressName
protected String	billingAddressTypeCode
protected String	billingCityName
protected String	billingCountryCode
protected Date	billingDate
protected Date	billingDateForDisplay
protected String	billingEmailAddress
protected String	billingInternationalMailCode
protected String	billingLine1StreetAddress
protected String	billingLine2StreetAddress
protected String	billingStateCode
protected String	billingZipCode
protected Date	closedDate
protected CustomerAddress	customerBillToAddress
protected Integer	customerBillToAddressIdentifier
protected CustomerInvoiceRecurrenceDetails	customerInvoiceRecurrenceDetails
protected String	customerName
protected Date	customerPurchaseOrderDate
protected String	customerPurchaseOrderNumber
protected boolean	customerRecordAttachmentIndicator
protected CustomerAddress	customerShipToAddress
protected Integer	customerShipToAddressIdentifier
protected CustomerProcessingType	customerSpecialProcessing
protected String	customerSpecialProcessingCode
protected static String	HAS_RECCURENCE_NODE
protected String	invoiceAttentionLineText
protected Date	invoiceDueDate
protected String	invoiceHeaderText
protected String	invoiceTermsText
protected static org.apache.log4j.Logger	LOG
protected boolean	openInvoiceIndicator
protected String	organizationInvoiceNumber
protected Account	paymentAccount
protected String	paymentAccountNumber
protected Chart	paymentChartOfAccounts
protected String	paymentChartOfAccountsCode
protected ObjectCode	paymentFinancialObject
protected String	paymentFinancialObjectCode
protected SubObjectCode	paymentFinancialSubObject
protected String	paymentFinancialSubObjectCode
protected String	paymentOrganizationReferenceIdentifier
protected ProjectCode	paymentProject
protected String	paymentProjectCode
protected SubAccount	paymentSubAccount
protected String	paymentSubAccountNumber
protected Date	printDate
protected String	printInvoiceIndicator
protected PrintInvoiceOptions	printInvoiceOption
protected boolean	recurredInvoiceIndicator
protected String	shippingAddressInternationalProvinceName
protected String	shippingAddressName
protected String	shippingAddressTypeCode
protected String	shippingCityName
protected String	shippingCountryCode
protected String	shippingEmailAddress
protected String	shippingInternationalMailCode
protected String	shippingLine1StreetAddress
protected String	shippingLine2StreetAddress
protected String	shippingStateCode
protected String	shippingZipCode

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

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

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

generalLedgerPendingEntries

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

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

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

documentHeader

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

documentBusinessObject, documentNumber

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

extension, versionNumber

Constructor Summary

CustomerInvoiceDocument()
Default constructor.

Method Summary

protected void	addIncomeGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper, GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, boolean hasClaimOnCashOffset) This method adds pending entry with transaction ledger entry amount set to item price * quantity
protected void	addReceivableGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper, GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, boolean hasClaimOnCashOffset) This method creates the receivable GLPEs for each invoice detail line.
protected void	addSalesTaxGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper, GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, boolean hasClaimOnCashOffset) This method add pending entries for every tax detail that exists for a particular postal code
boolean	answerSplitNodeQuestion(String nodeName) Answers true when invoice recurrence details are provided by the user
int	compareTo(CustomerInvoiceDocument customerInvoiceDocument)
void	doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent) When document is processed do the following: 1) Set the billingDate to today's date if not already set 2) If there are discounts, create corresponding invoice paid applied rows 3) If the document is a reversal, in addition to reversing paid applied rows, update the open paid applied indicator
boolean	generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) This method creates the following GLPE's for the invoice 1.
AccountsReceivableDocumentHeader	getAccountsReceivableDocumentHeader() Gets the accountsReceivableDocumentHeader attribute.
Integer	getAge() This method returns the age of an invoice (i.e.
Chart	getBillByChartOfAccount() Gets the billByChartOfAccount attribute.
String	getBillByChartOfAccountCode() Gets the billByChartOfAccountCode attribute.
String	getBilledByChartOfAccCodeAndOrgCode() Get a string representation for billing chart/organization
Organization	getBilledByOrganization() Gets the billedByOrganization attribute.
String	getBilledByOrganizationCode() Gets the billedByOrganizationCode attribute.
String	getBillingAddressInternationalProvinceName()
String	getBillingAddressName()
String	getBillingAddressTypeCode()
String	getBillingCityName()
String	getBillingCountryCode()
Date	getBillingDate() Gets the billingDate attribute.
Date	getBillingDateForDisplay() This method returns the billing date for display.
String	getBillingEmailAddress()
String	getBillingInternationalMailCode()
String	getBillingLine1StreetAddress()
String	getBillingLine2StreetAddress()
String	getBillingStateCode()
String	getBillingZipCode()
Date	getClosedDate()
Customer	getCustomer() This method returns the customer object for the invoice
CustomerAddress	getCustomerBillToAddress()
Integer	getCustomerBillToAddressIdentifier() Gets the customerBillToAddressIdentifier attribute.
List<CustomerInvoiceDetail>	getCustomerInvoiceDetailsWithoutDiscounts() This method will return all the customer invoice details excluding discount invoice detail lines.
CustomerInvoiceRecurrenceDetails	getCustomerInvoiceRecurrenceDetails()
String	getCustomerName()
Date	getCustomerPurchaseOrderDate() Gets the customerPurchaseOrderDate attribute.
String	getCustomerPurchaseOrderNumber() Gets the customerPurchaseOrderNumber attribute.
CustomerAddress	getCustomerShipToAddress()
Integer	getCustomerShipToAddressIdentifier() Gets the customerShipToAddressIdentifier attribute.
CustomerProcessingType	getCustomerSpecialProcessing() Gets the customerSpecialProcessing attribute.
String	getCustomerSpecialProcessingCode() Gets the customerSpecialProcessingCode attribute.
List<CustomerInvoiceDetail>	getDiscounts() This method will return all the customer invoice details that are discounts
String	getDocumentNumber() Gets the documentNumber attribute.
GeneralLedgerPendingEntryService	getGeneralLedgerPendingEntryService() Returns an implementation of the GeneralLedgerPendingEntryService
String	getInvoiceAttentionLineText() Gets the invoiceAttentionLineText attribute.
Date	getInvoiceDueDate() Gets the invoiceDueDate attribute.
String	getInvoiceHeaderText() Gets the invoiceHeaderText attribute.
org.kuali.rice.kns.util.KualiDecimal	getInvoiceItemPreTaxAmountTotal() This method returns the total of all pre tax amounts for all customer invoice detail lines
org.kuali.rice.kns.util.KualiDecimal	getInvoiceItemTaxAmountTotal() This method returns the total of all tax amounts for all customer invoice detail lines
protected String	getInvoiceRecurrenceMaintenanceDocumentTypeName()
String	getInvoiceTermsText() Gets the invoiceTermsText attribute.
boolean	getNoRecurrenceDataFlag()
org.kuali.rice.kns.util.KualiDecimal	getOpenAmount() This method calculates the outstanding balance on an invoice.
String	getOrganizationInvoiceNumber() Gets the organizationInvoiceNumber attribute.
String	getParentInvoiceNumber() This method...
CustomerInvoiceDetail	getParentLineBasedOnDiscountSequenceNumber(Integer discountSequenceNumber) This method returns parent customer invoice detail based on child discount sequence number
Account	getPaymentAccount() Gets the paymentAccount attribute.
String	getPaymentAccountNumber() Gets the paymentAccountNumber attribute.
Chart	getPaymentChartOfAccounts() Gets the paymentChartOfAccounts attribute.
String	getPaymentChartOfAccountsCode() Gets the paymentChartOfAccountsCode attribute.
ObjectCode	getPaymentFinancialObject() Gets the paymentFinancialObject attribute.
String	getPaymentFinancialObjectCode() Gets the paymentFinancialObjectCode attribute.
SubObjectCode	getPaymentFinancialSubObject() Gets the paymentFinancialSubObject attribute.
String	getPaymentFinancialSubObjectCode() Gets the paymentFinancialSubObjectCode attribute.
String	getPaymentOrganizationReferenceIdentifier() Gets the paymentOrganizationReferenceIdentifier attribute.
ProjectCode	getPaymentProject() Gets the paymentProject attribute.
String	getPaymentProjectCode() Gets the paymentProjectCode attribute.
SubAccount	getPaymentSubAccount() Gets the paymentSubAccount attribute.
String	getPaymentSubAccountNumber() Gets the paymentSubAccountNumber attribute.
CustomerAddress	getPrimaryAddressForCustomerNumber() This method returns the primary customer address for the customer number provided.
Date	getPrintDate() Gets the printDate attribute.
String	getPrintInvoiceIndicator() Gets the printInvoiceIndicator attribute.
PrintInvoiceOptions	getPrintInvoiceOption()
boolean	getProcessRecurrenceFlag()
boolean	getRecurredInvoiceIndicator()
String	getShippingAddressInternationalProvinceName()
String	getShippingAddressName()
String	getShippingAddressTypeCode()
String	getShippingCityName()
String	getShippingCountryCode()
String	getShippingEmailAddress()
String	getShippingInternationalMailCode()
String	getShippingLine1StreetAddress()
String	getShippingLine2StreetAddress()
String	getShippingStateCode()
String	getShippingZipCode()
Class<CustomerInvoiceDetail>	getSourceAccountingLineClass() Returns the default Source accounting line class.
org.kuali.rice.kns.util.KualiDecimal	getTotalDollarAmount() Since one side of the document should match the other and the document should balance, the total dollar amount for the document should either be the expense line or the income line.
Map	getValuesMap() Returns a map with the primitive field names as the key and the primitive values as the map value.
List<Long>	getWorkflowEngineDocumentIdsToLock()
boolean	hasAtLeastOneDiscount() This method returns true if invoice document has at least one discount line
protected boolean	hasRecurrence() Determines whether this document has a Recurrence filled out enough to create an INVR doc.
protected boolean	isBatchGenerated() Determines whether this document was generated from a recurrence batch.
boolean	isCustomerRecordAttachmentIndicator() Gets the customerRecordAttachmentIndicator attribute.
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) This method determines if the passed in GeneralLedgerPendingEntrySourceDetail is a debit or not.
boolean	isDiscountLineBasedOnSequenceNumber(Integer sequenceNumber) This method returns true if line number is discount line number based on sequence number
boolean	isInvoiceReversal() This method returns true if this document is a reversal for another document
boolean	isOpenInvoiceIndicator() Gets the openInvoiceIndicator attribute.
void	negateCustomerInvoiceDetailUnitPrices() This method...
void	prepareForSave() If this invoice is a reversal, set the open indicator to false
void	removeDiscountLineBasedOnParentLineIndex(int parentLineIndex) This method removes the corresponding discount line based on the index of the parent line index.
void	setAccountsReceivableDocumentHeader(AccountsReceivableDocumentHeader accountsReceivableDocumentHeader) Sets the accountsReceivableDocumentHeader attribute.
void	setAge(Integer age)
void	setBillByChartOfAccount(Chart billByChartOfAccount) Deprecated.
void	setBillByChartOfAccountCode(String billByChartOfAccountCode) Sets the billByChartOfAccountCode attribute.
void	setBilledByOrganization(Organization billedByOrganization) Deprecated.
void	setBilledByOrganizationCode(String billedByOrganizationCode) Sets the billedByOrganizationCode attribute.
void	setBillingAddressInternationalProvinceName(String billingAddressInternationalProvinceName)
void	setBillingAddressName(String billingAddressName)
void	setBillingAddressTypeCode(String billingAddressTypeCode)
void	setBillingCityName(String billingCityName)
void	setBillingCountryCode(String billingCountryCode)
void	setBillingDate(Date billingDate) Sets the billingDate attribute.
void	setBillingDateForDisplay(Date date) This method...
void	setBillingEmailAddress(String billingEmailAddress)
void	setBillingInternationalMailCode(String billingInternationalMailCode)
void	setBillingLine1StreetAddress(String billingLine1StreetAddress)
void	setBillingLine2StreetAddress(String billingLine2StreetAddress)
void	setBillingStateCode(String billingStateCode)
void	setBillingZipCode(String billingZipCode)
void	setClosedDate(Date closedDate)
void	setCustomerBillToAddress(CustomerAddress customerBillToAddress)
void	setCustomerBillToAddressIdentifier(Integer customerBillToAddressIdentifier) Sets the customerBillToAddressIdentifier attribute.
void	setCustomerBillToAddressOnInvoice(CustomerAddress customerBillToAddress) Populate Customer Billing Address fields on Customer Invoice.
void	setCustomerInvoiceRecurrenceDetails(CustomerInvoiceRecurrenceDetails customerInvoiceRecurrenceDetails)
void	setCustomerName(String customerName)
void	setCustomerPurchaseOrderDate(Date customerPurchaseOrderDate) Sets the customerPurchaseOrderDate attribute.
void	setCustomerPurchaseOrderNumber(String customerPurchaseOrderNumber) Sets the customerPurchaseOrderNumber attribute.
void	setCustomerRecordAttachmentIndicator(boolean customerRecordAttachmentIndicator) Sets the customerRecordAttachmentIndicator attribute.
void	setCustomerShipToAddress(CustomerAddress customerShipToAddress)
void	setCustomerShipToAddressIdentifier(Integer customerShipToAddressIdentifier) Sets the customerShipToAddressIdentifier attribute.
void	setCustomerShipToAddressOnInvoice(CustomerAddress customerShipToAddress) Populate Customer Shipping Address fields on Customer Invoice.
void	setCustomerSpecialProcessing(CustomerProcessingType customerSpecialProcessing) Deprecated.
void	setCustomerSpecialProcessingCode(String customerSpecialProcessingCode) Sets the customerSpecialProcessingCode attribute.
void	setDocumentNumber(String documentNumber) Sets the documentNumber attribute.
void	setInvoiceAttentionLineText(String invoiceAttentionLineText) Sets the invoiceAttentionLineText attribute.
void	setInvoiceDueDate(Date invoiceDueDate) Sets the invoiceDueDate attribute.
void	setInvoiceHeaderText(String invoiceHeaderText) Sets the invoiceHeaderText attribute.
void	setInvoiceTermsText(String invoiceTermsText) Sets the invoiceTermsText attribute.
void	setOpenInvoiceIndicator(boolean openInvoiceIndicator) Sets the openInvoiceIndicator attribute.
void	setOrganizationInvoiceNumber(String organizationInvoiceNumber) Sets the organizationInvoiceNumber attribute.
void	setPaymentAccount(Account paymentAccount) Deprecated.
void	setPaymentAccountNumber(String paymentAccountNumber) Sets the paymentAccountNumber attribute value.
void	setPaymentChartOfAccounts(Chart paymentChartOfAccounts) Deprecated.
void	setPaymentChartOfAccountsCode(String paymentChartOfAccountsCode) Sets the paymentChartOfAccountsCode attribute value.
void	setPaymentFinancialObject(ObjectCode paymentFinancialObject) Deprecated.
void	setPaymentFinancialObjectCode(String paymentFinancialObjectCode) Sets the paymentFinancialObjectCode attribute value.
void	setPaymentFinancialSubObject(SubObjectCode paymentFinancialSubObject) Deprecated.
void	setPaymentFinancialSubObjectCode(String paymentFinancialSubObjectCode) Sets the paymentFinancialSubObjectCode attribute value.
void	setPaymentOrganizationReferenceIdentifier(String paymentOrganizationReferenceIdentifier) Sets the paymentOrganizationReferenceIdentifier attribute value.
void	setPaymentProject(ProjectCode paymentProject) Deprecated.
void	setPaymentProjectCode(String paymentProjectCode) Sets the paymentProjectCode attribute value.
void	setPaymentSubAccount(SubAccount paymentSubAccount) Deprecated.
void	setPaymentSubAccountNumber(String paymentSubAccountNumber) Sets the paymentSubAccountNumber attribute value.
void	setPrintDate(Date printDate) Sets the printDate attribute.
void	setPrintInvoiceIndicator(String printInvoiceIndicator) Sets the printInvoiceIndicator attribute value.
void	setPrintInvoiceOption(PrintInvoiceOptions printInvoiceOption)
void	setRecurredInvoiceIndicator(boolean recurredInvoiceIndicator)
void	setShippingAddressInternationalProvinceName(String shippingAddressInternationalProvinceName)
void	setShippingAddressName(String shippingAddressName)
void	setShippingAddressTypeCode(String shippingAddressTypeCode)
void	setShippingCityName(String shippingCityName)
void	setShippingCountryCode(String shippingCountryCode)
void	setShippingEmailAddress(String shippingEmailAddress)
void	setShippingInternationalMailCode(String shippingInternationalMailCode)
void	setShippingLine1StreetAddress(String shippingLine1StreetAddress)
void	setShippingLine2StreetAddress(String shippingLine2StreetAddress)
void	setShippingStateCode(String shippingStateCode)
void	setShippingZipCode(String shippingZipCode)
void	toCopy() If we've copied, we need to update the posting period and year
void	toErrorCorrection() Converts this Document instance into an error correction of itself.
protected LinkedHashMap	toStringMapper()
void	updateAccountReceivableObjectCodes() Ensures that all the accounts receivable object codes are correctly updated
void	updateDiscountAndParentLineReferences() This method is called on CustomerInvoiceDocumentAction.execute() to set isDiscount to true if it truly is a discount line
boolean	wouldPayOff(org.kuali.rice.kns.util.KualiDecimal additionalAmountToApply) Returns whether or not the Invoice would be paid off by applying the additional amount, passed in by the parameter.

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

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

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

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

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

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

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

getDocumentHeader, processAfterRetrieve, setDocumentHeader

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

getAllowsCopy, isSessionDocument

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

addCopyErrorDocumentNote, addPessimisticLock, afterLookup, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getXmlForRouteReport, logErrors, populateDocumentForRouting, postProcessSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setNewDocumentHeader, setPessimisticLocks, toString, toStringBuilder, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

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

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

prepareForWorkflow

Methods inherited from class java.lang.Object

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

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

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

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

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from interface org.kuali.kfs.sys.document.FinancialSystemTransactionalDocument

getDocumentHeader

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

addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, processAfterRetrieve, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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

addNote, 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

Methods inherited from interface org.kuali.kfs.sys.document.GeneralLedgerPendingEntrySource

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getPostingYear

Field Detail

HAS_RECCURENCE_NODE

protected static final String HAS_RECCURENCE_NODE

See Also:

Constant Field Values

BATCH_GENERATED_NODE

protected static final String BATCH_GENERATED_NODE

See Also:

Constant Field Values

invoiceHeaderText

protected String invoiceHeaderText

invoiceAttentionLineText

protected String invoiceAttentionLineText

invoiceDueDate

protected Date invoiceDueDate

billingDate

protected Date billingDate

closedDate

protected Date closedDate

billingDateForDisplay

protected Date billingDateForDisplay

invoiceTermsText

protected String invoiceTermsText

organizationInvoiceNumber

protected String organizationInvoiceNumber

customerPurchaseOrderNumber

protected String customerPurchaseOrderNumber

printInvoiceIndicator

protected String printInvoiceIndicator

customerPurchaseOrderDate

protected Date customerPurchaseOrderDate

billByChartOfAccountCode

protected String billByChartOfAccountCode

billedByOrganizationCode

protected String billedByOrganizationCode

customerShipToAddressIdentifier

protected Integer customerShipToAddressIdentifier

customerBillToAddressIdentifier

protected Integer customerBillToAddressIdentifier

customerSpecialProcessingCode

protected String customerSpecialProcessingCode

customerRecordAttachmentIndicator

protected boolean customerRecordAttachmentIndicator

openInvoiceIndicator

protected boolean openInvoiceIndicator

paymentChartOfAccountsCode

protected String paymentChartOfAccountsCode

paymentAccountNumber

protected String paymentAccountNumber

paymentSubAccountNumber

protected String paymentSubAccountNumber

paymentFinancialObjectCode

protected String paymentFinancialObjectCode

paymentFinancialSubObjectCode

protected String paymentFinancialSubObjectCode

paymentProjectCode

protected String paymentProjectCode

paymentOrganizationReferenceIdentifier

protected String paymentOrganizationReferenceIdentifier

printDate

protected Date printDate

age

protected Integer age

customerName

protected String customerName

billingAddressName

protected String billingAddressName

billingCityName

protected String billingCityName

billingStateCode

protected String billingStateCode

billingZipCode

protected String billingZipCode

billingCountryCode

protected String billingCountryCode

billingAddressInternationalProvinceName

protected String billingAddressInternationalProvinceName

billingInternationalMailCode

protected String billingInternationalMailCode

billingEmailAddress

protected String billingEmailAddress

billingAddressTypeCode

protected String billingAddressTypeCode

billingLine1StreetAddress

protected String billingLine1StreetAddress

billingLine2StreetAddress

protected String billingLine2StreetAddress

shippingLine1StreetAddress

protected String shippingLine1StreetAddress

shippingLine2StreetAddress

protected String shippingLine2StreetAddress

shippingAddressName

protected String shippingAddressName

shippingCityName

protected String shippingCityName

shippingStateCode

protected String shippingStateCode

shippingZipCode

protected String shippingZipCode

shippingCountryCode

protected String shippingCountryCode

shippingAddressInternationalProvinceName

protected String shippingAddressInternationalProvinceName

shippingInternationalMailCode

protected String shippingInternationalMailCode

shippingEmailAddress

protected String shippingEmailAddress

shippingAddressTypeCode

protected String shippingAddressTypeCode

recurredInvoiceIndicator

protected boolean recurredInvoiceIndicator

accountsReceivableDocumentHeader

protected AccountsReceivableDocumentHeader accountsReceivableDocumentHeader

billByChartOfAccount

protected Chart billByChartOfAccount

billedByOrganization

protected Organization billedByOrganization

customerSpecialProcessing

protected CustomerProcessingType customerSpecialProcessing

paymentAccount

protected Account paymentAccount

paymentChartOfAccounts

protected Chart paymentChartOfAccounts

paymentSubAccount

protected SubAccount paymentSubAccount

paymentFinancialObject

protected ObjectCode paymentFinancialObject

paymentFinancialSubObject

protected SubObjectCode paymentFinancialSubObject

paymentProject

protected ProjectCode paymentProject

printInvoiceOption

protected PrintInvoiceOptions printInvoiceOption

customerShipToAddress

protected CustomerAddress customerShipToAddress

customerBillToAddress

protected CustomerAddress customerBillToAddress

customerInvoiceRecurrenceDetails

protected CustomerInvoiceRecurrenceDetails customerInvoiceRecurrenceDetails

LOG

protected static org.apache.log4j.Logger LOG

Constructor Detail

CustomerInvoiceDocument

public CustomerInvoiceDocument()

Default constructor.

Method Detail

getOpenAmount

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

This method calculates the outstanding balance on an invoice.

Returns:

the outstanding balance on this invoice

getDocumentNumber

public String getDocumentNumber()

Gets the documentNumber attribute.

Specified by:

getDocumentNumber in interface org.kuali.rice.kns.document.Document

Overrides:

getDocumentNumber in class org.kuali.rice.kns.document.DocumentBase

Returns:

Returns the documentNumber

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Sets the documentNumber attribute.

Specified by:

setDocumentNumber in interface org.kuali.rice.kns.document.Document

Overrides:

setDocumentNumber in class org.kuali.rice.kns.document.DocumentBase

Parameters:

documentNumber - The documentNumber to set.

getInvoiceHeaderText

public String getInvoiceHeaderText()

Gets the invoiceHeaderText attribute.

Returns:

Returns the invoiceHeaderText

setInvoiceHeaderText

public void setInvoiceHeaderText(String invoiceHeaderText)

Sets the invoiceHeaderText attribute.

Parameters:

invoiceHeaderText - The invoiceHeaderText to set.

getInvoiceAttentionLineText

public String getInvoiceAttentionLineText()

Gets the invoiceAttentionLineText attribute.

Returns:

Returns the invoiceAttentionLineText

setInvoiceAttentionLineText

public void setInvoiceAttentionLineText(String invoiceAttentionLineText)

Sets the invoiceAttentionLineText attribute.

Parameters:

invoiceAttentionLineText - The invoiceAttentionLineText to set.

getInvoiceDueDate

public Date getInvoiceDueDate()

Gets the invoiceDueDate attribute.

Returns:

Returns the invoiceDueDate

setInvoiceDueDate

public void setInvoiceDueDate(Date invoiceDueDate)

Sets the invoiceDueDate attribute.

Parameters:

invoiceDueDate - The invoiceDueDate to set.

getBillingDate

public Date getBillingDate()

Gets the billingDate attribute.

Returns:

Returns the billingDate

getAge

public Integer getAge()

This method returns the age of an invoice (i.e. current date - billing date)

Returns:

setAge

public void setAge(Integer age)

setBillingDate

public void setBillingDate(Date billingDate)

Sets the billingDate attribute.

Parameters:

billingDate - The billingDate to set.

getInvoiceTermsText

public String getInvoiceTermsText()

Gets the invoiceTermsText attribute.

Returns:

Returns the invoiceTermsText

setInvoiceTermsText

public void setInvoiceTermsText(String invoiceTermsText)

Sets the invoiceTermsText attribute.

Parameters:

invoiceTermsText - The invoiceTermsText to set.

getOrganizationInvoiceNumber

public String getOrganizationInvoiceNumber()

Gets the organizationInvoiceNumber attribute.

Returns:

Returns the organizationInvoiceNumber

setOrganizationInvoiceNumber

public void setOrganizationInvoiceNumber(String organizationInvoiceNumber)

Sets the organizationInvoiceNumber attribute.

Parameters:

organizationInvoiceNumber - The organizationInvoiceNumber to set.

getCustomerPurchaseOrderNumber

public String getCustomerPurchaseOrderNumber()

Gets the customerPurchaseOrderNumber attribute.

Returns:

Returns the customerPurchaseOrderNumber

setCustomerPurchaseOrderNumber

public void setCustomerPurchaseOrderNumber(String customerPurchaseOrderNumber)

Sets the customerPurchaseOrderNumber attribute.

Parameters:

customerPurchaseOrderNumber - The customerPurchaseOrderNumber to set.

getPrintInvoiceIndicator

public String getPrintInvoiceIndicator()

Gets the printInvoiceIndicator attribute.

Returns:

Returns the printInvoiceIndicator.

setPrintInvoiceIndicator

public void setPrintInvoiceIndicator(String printInvoiceIndicator)

Sets the printInvoiceIndicator attribute value.

Parameters:

printInvoiceIndicator - The printInvoiceIndicator to set.

getCustomerPurchaseOrderDate

public Date getCustomerPurchaseOrderDate()

Gets the customerPurchaseOrderDate attribute.

Returns:

Returns the customerPurchaseOrderDate

setCustomerPurchaseOrderDate

public void setCustomerPurchaseOrderDate(Date customerPurchaseOrderDate)

Sets the customerPurchaseOrderDate attribute.

Parameters:

customerPurchaseOrderDate - The customerPurchaseOrderDate to set.

getBillByChartOfAccountCode

public String getBillByChartOfAccountCode()

Gets the billByChartOfAccountCode attribute.

Returns:

Returns the billByChartOfAccountCode

setBillByChartOfAccountCode

public void setBillByChartOfAccountCode(String billByChartOfAccountCode)

Sets the billByChartOfAccountCode attribute.

Parameters:

billByChartOfAccountCode - The billByChartOfAccountCode to set.

getBilledByOrganizationCode

public String getBilledByOrganizationCode()

Gets the billedByOrganizationCode attribute.

Returns:

Returns the billedByOrganizationCode

setBilledByOrganizationCode

public void setBilledByOrganizationCode(String billedByOrganizationCode)

Sets the billedByOrganizationCode attribute.

Parameters:

billedByOrganizationCode - The billedByOrganizationCode to set.

getCustomerShipToAddressIdentifier

public Integer getCustomerShipToAddressIdentifier()

Gets the customerShipToAddressIdentifier attribute.

Returns:

Returns the customerShipToAddressIdentifier

setCustomerShipToAddressIdentifier

public void setCustomerShipToAddressIdentifier(Integer customerShipToAddressIdentifier)

Sets the customerShipToAddressIdentifier attribute.

Parameters:

customerShipToAddressIdentifier - The customerShipToAddressIdentifier to set.

getCustomerBillToAddressIdentifier

public Integer getCustomerBillToAddressIdentifier()

Gets the customerBillToAddressIdentifier attribute.

Returns:

Returns the customerBillToAddressIdentifier

setCustomerBillToAddressIdentifier

public void setCustomerBillToAddressIdentifier(Integer customerBillToAddressIdentifier)

Sets the customerBillToAddressIdentifier attribute.

Parameters:

customerBillToAddressIdentifier - The customerBillToAddressIdentifier to set.

getCustomerSpecialProcessingCode

public String getCustomerSpecialProcessingCode()

Gets the customerSpecialProcessingCode attribute.

Returns:

Returns the customerSpecialProcessingCode

setCustomerSpecialProcessingCode

public void setCustomerSpecialProcessingCode(String customerSpecialProcessingCode)

Sets the customerSpecialProcessingCode attribute.

Parameters:

customerSpecialProcessingCode - The customerSpecialProcessingCode to set.

isCustomerRecordAttachmentIndicator

public boolean isCustomerRecordAttachmentIndicator()

Gets the customerRecordAttachmentIndicator attribute.

Returns:

Returns the customerRecordAttachmentIndicator

setCustomerRecordAttachmentIndicator

public void setCustomerRecordAttachmentIndicator(boolean customerRecordAttachmentIndicator)

Sets the customerRecordAttachmentIndicator attribute.

Parameters:

customerRecordAttachmentIndicator - The customerRecordAttachmentIndicator to set.

isOpenInvoiceIndicator

public boolean isOpenInvoiceIndicator()

Gets the openInvoiceIndicator attribute.

Returns:

Returns the openInvoiceIndicator

setOpenInvoiceIndicator

public void setOpenInvoiceIndicator(boolean openInvoiceIndicator)

Sets the openInvoiceIndicator attribute.

Parameters:

openInvoiceIndicator - The openInvoiceIndicator to set.

getPaymentAccountNumber

public String getPaymentAccountNumber()

Gets the paymentAccountNumber attribute.

Returns:

Returns the paymentAccountNumber.

setPaymentAccountNumber

public void setPaymentAccountNumber(String paymentAccountNumber)

Sets the paymentAccountNumber attribute value.

Parameters:

paymentAccountNumber - The paymentAccountNumber to set.

getPaymentChartOfAccountsCode

public String getPaymentChartOfAccountsCode()

Gets the paymentChartOfAccountsCode attribute.

Returns:

Returns the paymentChartOfAccountsCode.

setPaymentChartOfAccountsCode

public void setPaymentChartOfAccountsCode(String paymentChartOfAccountsCode)

Sets the paymentChartOfAccountsCode attribute value.

Parameters:

paymentChartOfAccountsCode - The paymentChartOfAccountsCode to set.

getPaymentFinancialObjectCode

public String getPaymentFinancialObjectCode()

Gets the paymentFinancialObjectCode attribute.

Returns:

Returns the paymentFinancialObjectCode.

setPaymentFinancialObjectCode

public void setPaymentFinancialObjectCode(String paymentFinancialObjectCode)

Sets the paymentFinancialObjectCode attribute value.

Parameters:

paymentFinancialObjectCode - The paymentFinancialObjectCode to set.

getPaymentFinancialSubObjectCode

public String getPaymentFinancialSubObjectCode()

Gets the paymentFinancialSubObjectCode attribute.

Returns:

Returns the paymentFinancialSubObjectCode.

setPaymentFinancialSubObjectCode

public void setPaymentFinancialSubObjectCode(String paymentFinancialSubObjectCode)

Sets the paymentFinancialSubObjectCode attribute value.

Parameters:

paymentFinancialSubObjectCode - The paymentFinancialSubObjectCode to set.

getPaymentOrganizationReferenceIdentifier

public String getPaymentOrganizationReferenceIdentifier()

Gets the paymentOrganizationReferenceIdentifier attribute.

Returns:

Returns the paymentOrganizationReferenceIdentifier.

setPaymentOrganizationReferenceIdentifier

public void setPaymentOrganizationReferenceIdentifier(String paymentOrganizationReferenceIdentifier)

Sets the paymentOrganizationReferenceIdentifier attribute value.

Parameters:

paymentOrganizationReferenceIdentifier - The paymentOrganizationReferenceIdentifier to set.

getPaymentProjectCode

public String getPaymentProjectCode()

Gets the paymentProjectCode attribute.

Returns:

Returns the paymentProjectCode.

setPaymentProjectCode

public void setPaymentProjectCode(String paymentProjectCode)

Sets the paymentProjectCode attribute value.

Parameters:

paymentProjectCode - The paymentProjectCode to set.

getPaymentSubAccountNumber

public String getPaymentSubAccountNumber()

Gets the paymentSubAccountNumber attribute.

Returns:

Returns the paymentSubAccountNumber.

setPaymentSubAccountNumber

public void setPaymentSubAccountNumber(String paymentSubAccountNumber)

Sets the paymentSubAccountNumber attribute value.

Parameters:

paymentSubAccountNumber - The paymentSubAccountNumber to set.

getPrintDate

public Date getPrintDate()

Gets the printDate attribute.

Returns:

Returns the printDate

setPrintDate

public void setPrintDate(Date printDate)

Sets the printDate attribute.

Parameters:

printDate - The printDate to set.

getAccountsReceivableDocumentHeader

public AccountsReceivableDocumentHeader getAccountsReceivableDocumentHeader()

Gets the accountsReceivableDocumentHeader attribute.

Returns:

Returns the accountsReceivableDocumentHeader

setAccountsReceivableDocumentHeader

public void setAccountsReceivableDocumentHeader(AccountsReceivableDocumentHeader accountsReceivableDocumentHeader)

Sets the accountsReceivableDocumentHeader attribute.

Parameters:

accountsReceivableDocumentHeader - The accountsReceivableDocumentHeader to set.

getParentInvoiceNumber

public String getParentInvoiceNumber()

This method...

Returns:

getBillByChartOfAccount

public Chart getBillByChartOfAccount()

Gets the billByChartOfAccount attribute.

Returns:

Returns the billByChartOfAccount

setBillByChartOfAccount

public void setBillByChartOfAccount(Chart billByChartOfAccount)

Deprecated.

Sets the billByChartOfAccount attribute.

Parameters:

billByChartOfAccount - The billByChartOfAccount to set.

getBilledByOrganization

public Organization getBilledByOrganization()

Gets the billedByOrganization attribute.

Returns:

Returns the billedByOrganization

setBilledByOrganization

public void setBilledByOrganization(Organization billedByOrganization)

Deprecated.

Sets the billedByOrganization attribute.

Parameters:

billedByOrganization - The billedByOrganization to set.

getCustomerSpecialProcessing

public CustomerProcessingType getCustomerSpecialProcessing()

Gets the customerSpecialProcessing attribute.

Returns:

Returns the customerSpecialProcessing

setCustomerSpecialProcessing

public void setCustomerSpecialProcessing(CustomerProcessingType customerSpecialProcessing)

Deprecated.

Sets the customerSpecialProcessing attribute.

Parameters:

customerSpecialProcessing - The customerSpecialProcessing to set.

getPaymentAccount

public Account getPaymentAccount()

Gets the paymentAccount attribute.

Returns:

Returns the paymentAccount.

setPaymentAccount

public void setPaymentAccount(Account paymentAccount)

Deprecated.

Sets the paymentAccount attribute value.

Parameters:

paymentAccount - The paymentAccount to set.

getPaymentChartOfAccounts

public Chart getPaymentChartOfAccounts()

Gets the paymentChartOfAccounts attribute.

Returns:

Returns the paymentChartOfAccounts.

setPaymentChartOfAccounts

public void setPaymentChartOfAccounts(Chart paymentChartOfAccounts)

Deprecated.

Sets the paymentChartOfAccounts attribute value.

Parameters:

paymentChartOfAccounts - The paymentChartOfAccounts to set.

getPaymentFinancialObject

public ObjectCode getPaymentFinancialObject()

Gets the paymentFinancialObject attribute.

Returns:

Returns the paymentFinancialObject.

setPaymentFinancialObject

public void setPaymentFinancialObject(ObjectCode paymentFinancialObject)

Deprecated.

Sets the paymentFinancialObject attribute value.

Parameters:

paymentFinancialObject - The paymentFinancialObject to set.

getPaymentFinancialSubObject

public SubObjectCode getPaymentFinancialSubObject()

Gets the paymentFinancialSubObject attribute.

Returns:

Returns the paymentFinancialSubObject.

setPaymentFinancialSubObject

public void setPaymentFinancialSubObject(SubObjectCode paymentFinancialSubObject)

Deprecated.

Sets the paymentFinancialSubObject attribute value.

Parameters:

paymentFinancialSubObject - The paymentFinancialSubObject to set.

getPaymentProject

public ProjectCode getPaymentProject()

Gets the paymentProject attribute.

Returns:

Returns the paymentProject.

setPaymentProject

public void setPaymentProject(ProjectCode paymentProject)

Deprecated.

Sets the paymentProject attribute value.

Parameters:

paymentProject - The paymentProject to set.

getPaymentSubAccount

public SubAccount getPaymentSubAccount()

Gets the paymentSubAccount attribute.

Returns:

Returns the paymentSubAccount.

setPaymentSubAccount

public void setPaymentSubAccount(SubAccount paymentSubAccount)

Deprecated.

Sets the paymentSubAccount attribute value.

Parameters:

paymentSubAccount - The paymentSubAccount to set.

getBillingDateForDisplay

public Date getBillingDateForDisplay()

This method returns the billing date for display. If billing date hasn't been set yet, just display current date

Returns:

setBillingDateForDisplay

public void setBillingDateForDisplay(Date date)

This method...

Parameters:

date -

getClosedDate

public Date getClosedDate()

setClosedDate

public void setClosedDate(Date closedDate)

toStringMapper

protected LinkedHashMap toStringMapper()

Overrides:

toStringMapper in class org.kuali.rice.kns.document.DocumentBase

See Also:

BusinessObjectBase.toStringMapper()

isInvoiceReversal

public boolean isInvoiceReversal()

This method returns true if this document is a reversal for another document

Returns:

isDebit

public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)

Description copied from interface: GeneralLedgerPendingEntrySource

This method determines if the passed in GeneralLedgerPendingEntrySourceDetail is a debit or not.

Specified by:

isDebit in interface GeneralLedgerPendingEntrySource

Specified by:

isDebit in class AccountingDocumentBase

Returns:

true if the given GeneralLedgerPendingEntrySourceDetail is a debit, false if it is a credit

See Also:

AccountingDocumentBase.isDebit(org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail)

getSourceAccountingLineClass

public Class<CustomerInvoiceDetail> getSourceAccountingLineClass()

Description copied from class: AccountingDocumentBase

Returns the default Source accounting line class.

Specified by:

getSourceAccountingLineClass in interface AccountingDocument

Overrides:

getSourceAccountingLineClass in class AccountingDocumentBase

See Also:

AccountingDocumentBase.getSourceAccountingLineClass()

updateAccountReceivableObjectCodes

public void updateAccountReceivableObjectCodes()

Ensures that all the accounts receivable object codes are correctly updated

generateGeneralLedgerPendingEntries

public boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
                                                   GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

This method creates the following GLPE's for the invoice 1. Debit to receivable for total line amount ( including sales tax if it exists ). 2. Credit to income based on item price * quantity. 3. Credit to state sales tax account/object code if state sales tax exists. 4. Credit to district sales tax account/object code if district sales tax exists.

Specified by:

generateGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Overrides:

generateGeneralLedgerPendingEntries in class AccountingDocumentBase

Parameters:

glpeSourceDetail - the source detail line to generate general ledger pending entries for

sequenceHelper - the sequence helper which will assign sequence number to generated general ledger pending entries

Returns:

true if general ledger pending entry generation was successful; false if an error condition prevented the successful generation of the pending entries

See Also:

org.kuali.kfs.service.impl.GenericGeneralLedgerPendingEntryGenerationProcessImpl#processGenerateGeneralLedgerPendingEntries(org.kuali.kfs.sys.document.GeneralLedgerPendingEntrySource, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySourceDetail, org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

addReceivableGLPEs

protected void addReceivableGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                                  GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
                                  boolean hasClaimOnCashOffset)

This method creates the receivable GLPEs for each invoice detail line.

Parameters:

poster -

sequenceHelper -

postable -

explicitEntry -

addIncomeGLPEs

protected void addIncomeGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                              GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
                              boolean hasClaimOnCashOffset)

This method adds pending entry with transaction ledger entry amount set to item price * quantity

Parameters:

poster -

sequenceHelper -

postable -

explicitEntry -

addSalesTaxGLPEs

protected void addSalesTaxGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                                GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
                                boolean hasClaimOnCashOffset)

This method add pending entries for every tax detail that exists for a particular postal code

Parameters:

sequenceHelper -

glpeSourceDetail -

hasClaimOnCashOffset -

getGeneralLedgerPendingEntryService

public GeneralLedgerPendingEntryService getGeneralLedgerPendingEntryService()

Returns an implementation of the GeneralLedgerPendingEntryService

Returns:

an implementation of the GeneralLedgerPendingEntryService

getValuesMap

public Map getValuesMap()

Returns a map with the primitive field names as the key and the primitive values as the map value.

Returns:

Map

getWorkflowEngineDocumentIdsToLock

public List<Long> getWorkflowEngineDocumentIdsToLock()

Specified by:

getWorkflowEngineDocumentIdsToLock in interface org.kuali.rice.kns.document.Document

Overrides:

getWorkflowEngineDocumentIdsToLock in class org.kuali.rice.kns.document.DocumentBase

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)

When document is processed do the following: 1) Set the billingDate to today's date if not already set 2) If there are discounts, create corresponding invoice paid applied rows 3) If the document is a reversal, in addition to reversing paid applied rows, update the open paid applied indicator

Specified by:

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

Overrides:

doRouteStatusChange in class GeneralLedgerPostingDocumentBase

See Also:

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

getInvoiceRecurrenceMaintenanceDocumentTypeName

protected String getInvoiceRecurrenceMaintenanceDocumentTypeName()

prepareForSave

public void prepareForSave()

If this invoice is a reversal, set the open indicator to false

Specified by:

prepareForSave in interface org.kuali.rice.kns.document.Document

Overrides:

prepareForSave in class FinancialSystemTransactionalDocumentBase

See Also:

FinancialSystemTransactionalDocumentBase.prepareForSave()

getProcessRecurrenceFlag

public boolean getProcessRecurrenceFlag()

getNoRecurrenceDataFlag

public boolean getNoRecurrenceDataFlag()

toCopy

public void toCopy()
            throws org.kuali.rice.kew.exception.WorkflowException

Description copied from class: LedgerPostingDocumentBase

If we've copied, we need to update the posting period and year

Specified by:

toCopy in interface org.kuali.rice.kns.document.Copyable

Overrides:

toCopy in class AccountingDocumentBase

Throws:

org.kuali.rice.kew.exception.WorkflowException

See Also:

AccountingDocumentBase.toCopy()

toErrorCorrection

public void toErrorCorrection()
                       throws org.kuali.rice.kew.exception.WorkflowException

Description copied from interface: Correctable

Converts this Document instance into an error correction of itself.

Specified by:

toErrorCorrection in interface Correctable

Overrides:

toErrorCorrection in class AccountingDocumentBase

Throws:

org.kuali.rice.kew.exception.WorkflowException

See Also:

GeneralLedgerPostingDocumentBase.toErrorCorrection()

negateCustomerInvoiceDetailUnitPrices

public void negateCustomerInvoiceDetailUnitPrices()

This method...

hasAtLeastOneDiscount

public boolean hasAtLeastOneDiscount()

This method returns true if invoice document has at least one discount line

Returns:

isDiscountLineBasedOnSequenceNumber

public boolean isDiscountLineBasedOnSequenceNumber(Integer sequenceNumber)

This method returns true if line number is discount line number based on sequence number

Parameters:

sequenceNumber -

Returns:

getParentLineBasedOnDiscountSequenceNumber

public CustomerInvoiceDetail getParentLineBasedOnDiscountSequenceNumber(Integer discountSequenceNumber)

This method returns parent customer invoice detail based on child discount sequence number

Parameters:

sequenceNumber -

Returns:

updateDiscountAndParentLineReferences

public void updateDiscountAndParentLineReferences()

This method is called on CustomerInvoiceDocumentAction.execute() to set isDiscount to true if it truly is a discount line

removeDiscountLineBasedOnParentLineIndex

public void removeDiscountLineBasedOnParentLineIndex(int parentLineIndex)

This method removes the corresponding discount line based on the index of the parent line index. This assumes that the discount line is ALWAYS after the index of the parent line.

Parameters:

deleteIndex -

getCustomerInvoiceRecurrenceDetails

public CustomerInvoiceRecurrenceDetails getCustomerInvoiceRecurrenceDetails()

setCustomerInvoiceRecurrenceDetails

public void setCustomerInvoiceRecurrenceDetails(CustomerInvoiceRecurrenceDetails customerInvoiceRecurrenceDetails)

getCustomerShipToAddress

public CustomerAddress getCustomerShipToAddress()

setCustomerShipToAddress

public void setCustomerShipToAddress(CustomerAddress customerShipToAddress)

getCustomerBillToAddress

public CustomerAddress getCustomerBillToAddress()

setCustomerBillToAddress

public void setCustomerBillToAddress(CustomerAddress customerBillToAddress)

getPrintInvoiceOption

public PrintInvoiceOptions getPrintInvoiceOption()

setPrintInvoiceOption

public void setPrintInvoiceOption(PrintInvoiceOptions printInvoiceOption)

getInvoiceItemPreTaxAmountTotal

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

This method returns the total of all pre tax amounts for all customer invoice detail lines

Returns:

getInvoiceItemTaxAmountTotal

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

This method returns the total of all tax amounts for all customer invoice detail lines

Returns:

getPrimaryAddressForCustomerNumber

public CustomerAddress getPrimaryAddressForCustomerNumber()

This method returns the primary customer address for the customer number provided.

Returns:

getCustomer

public Customer getCustomer()

This method returns the customer object for the invoice

Returns:

getCustomerInvoiceDetailsWithoutDiscounts

public List<CustomerInvoiceDetail> getCustomerInvoiceDetailsWithoutDiscounts()

This method will return all the customer invoice details excluding discount invoice detail lines.

Returns:

getDiscounts

public List<CustomerInvoiceDetail> getDiscounts()

This method will return all the customer invoice details that are discounts

Returns:

compareTo

public int compareTo(CustomerInvoiceDocument customerInvoiceDocument)

Specified by:

compareTo in interface Comparable<CustomerInvoiceDocument>

wouldPayOff

public boolean wouldPayOff(org.kuali.rice.kns.util.KualiDecimal additionalAmountToApply)

Returns whether or not the Invoice would be paid off by applying the additional amount, passed in by the parameter.

Parameters:

additionalAmountToApply - The additional applied amount to test against.

Returns:

True if applying the additionalAmountToApply parameter amount would bring the OpenAmount to zero.

getTotalDollarAmount

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

Description copied from class: AccountingDocumentBase

Since one side of the document should match the other and the document should balance, the total dollar amount for the document should either be the expense line or the income line. This is the default implementation of this interface method so it should be overridden appropriately if your document cannot make this assumption.

Specified by:

getTotalDollarAmount in interface AmountTotaling

Overrides:

getTotalDollarAmount in class AccountingDocumentBase

Returns:

if target total is zero, source total, otherwise target total

getBillingAddressInternationalProvinceName

public String getBillingAddressInternationalProvinceName()

setBillingAddressInternationalProvinceName

public void setBillingAddressInternationalProvinceName(String billingAddressInternationalProvinceName)

getBillingAddressName

public String getBillingAddressName()

setBillingAddressName

public void setBillingAddressName(String billingAddressName)

getBillingAddressTypeCode

public String getBillingAddressTypeCode()

setBillingAddressTypeCode

public void setBillingAddressTypeCode(String billingAddressTypeCode)

getBillingCityName

public String getBillingCityName()

setBillingCityName

public void setBillingCityName(String billingCityName)

getBillingCountryCode

public String getBillingCountryCode()

setBillingCountryCode

public void setBillingCountryCode(String billingCountryCode)

getBillingEmailAddress

public String getBillingEmailAddress()

setBillingEmailAddress

public void setBillingEmailAddress(String billingEmailAddress)

getBillingInternationalMailCode

public String getBillingInternationalMailCode()

setBillingInternationalMailCode

public void setBillingInternationalMailCode(String billingInternationalMailCode)

getBillingStateCode

public String getBillingStateCode()

setBillingStateCode

public void setBillingStateCode(String billingStateCode)

getBillingZipCode

public String getBillingZipCode()

setBillingZipCode

public void setBillingZipCode(String billingZipCode)

getCustomerName

public String getCustomerName()

setCustomerName

public void setCustomerName(String customerName)

getShippingAddressInternationalProvinceName

public String getShippingAddressInternationalProvinceName()

setShippingAddressInternationalProvinceName

public void setShippingAddressInternationalProvinceName(String shippingAddressInternationalProvinceName)

getShippingAddressName

public String getShippingAddressName()

setShippingAddressName

public void setShippingAddressName(String shippingAddressName)

getShippingAddressTypeCode

public String getShippingAddressTypeCode()

setShippingAddressTypeCode

public void setShippingAddressTypeCode(String shippingAddressTypeCode)

getShippingCityName

public String getShippingCityName()

setShippingCityName

public void setShippingCityName(String shippingCityName)

getShippingCountryCode

public String getShippingCountryCode()

setShippingCountryCode

public void setShippingCountryCode(String shippingCountryCode)

getShippingEmailAddress

public String getShippingEmailAddress()

setShippingEmailAddress

public void setShippingEmailAddress(String shippingEmailAddress)

getShippingInternationalMailCode

public String getShippingInternationalMailCode()

setShippingInternationalMailCode

public void setShippingInternationalMailCode(String shippingInternationalMailCode)

getShippingStateCode

public String getShippingStateCode()

setShippingStateCode

public void setShippingStateCode(String shippingStateCode)

getShippingZipCode

public String getShippingZipCode()

setShippingZipCode

public void setShippingZipCode(String shippingZipCode)

getBillingLine1StreetAddress

public String getBillingLine1StreetAddress()

setBillingLine1StreetAddress

public void setBillingLine1StreetAddress(String billingLine1StreetAddress)

getBillingLine2StreetAddress

public String getBillingLine2StreetAddress()

setBillingLine2StreetAddress

public void setBillingLine2StreetAddress(String billingLine2StreetAddress)

getShippingLine1StreetAddress

public String getShippingLine1StreetAddress()

setShippingLine1StreetAddress

public void setShippingLine1StreetAddress(String shippingLine1StreetAddress)

getShippingLine2StreetAddress

public String getShippingLine2StreetAddress()

setShippingLine2StreetAddress

public void setShippingLine2StreetAddress(String shippingLine2StreetAddress)

getRecurredInvoiceIndicator

public boolean getRecurredInvoiceIndicator()

setRecurredInvoiceIndicator

public void setRecurredInvoiceIndicator(boolean recurredInvoiceIndicator)

getBilledByChartOfAccCodeAndOrgCode

public String getBilledByChartOfAccCodeAndOrgCode()

Get a string representation for billing chart/organization

Returns:

setCustomerBillToAddressOnInvoice

public void setCustomerBillToAddressOnInvoice(CustomerAddress customerBillToAddress)

Populate Customer Billing Address fields on Customer Invoice.

setCustomerShipToAddressOnInvoice

public void setCustomerShipToAddressOnInvoice(CustomerAddress customerShipToAddress)

Populate Customer Shipping Address fields on Customer Invoice.

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Answers true when invoice recurrence details are provided by the user

Specified by:

answerSplitNodeQuestion in interface FinancialSystemTransactionalDocument

Overrides:

answerSplitNodeQuestion in class FinancialSystemTransactionalDocumentBase

Throws:

UnsupportedOperationException

See Also:

FinancialSystemTransactionalDocumentBase.answerSplitNodeQuestion(java.lang.String)

isBatchGenerated

protected boolean isBatchGenerated()

Determines whether this document was generated from a recurrence batch. Returns true if so, false if not.

Returns:

hasRecurrence

protected boolean hasRecurrence()

Determines whether this document has a Recurrence filled out enough to create an INVR doc.

Returns: