|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.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.module.ar.document.CustomerInvoiceWriteoffDocument
public class CustomerInvoiceWriteoffDocument
| Field Summary | |
|---|---|
protected Account |
account
|
protected String |
accountNumber
|
protected AccountsReceivableDocumentHeader |
accountsReceivableDocumentHeader
|
protected Chart |
chartOfAccounts
|
protected String |
chartOfAccountsCode
|
protected CustomerInvoiceDocument |
customerInvoiceDocument
|
protected String |
customerNote
|
protected String |
financialDocumentReferenceInvoiceNumber
|
protected ObjectCode |
financialObject
|
protected String |
financialObjectCode
|
protected SubObjectCode |
financialSubObject
|
protected String |
financialSubObjectCode
|
protected org.kuali.rice.kns.util.KualiDecimal |
invoiceWriteoffAmount
|
protected String |
organizationReferenceIdentifier
|
protected ProjectCode |
project
|
protected String |
projectCode
|
protected static String |
REQUIRES_APPROVAL_NODE
|
protected String |
statusCode
|
protected SubAccount |
subAccount
|
protected String |
subAccountNumber
|
| Fields inherited from class org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase |
|---|
generalLedgerPendingEntries, LOG |
| 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 | |
|---|---|
CustomerInvoiceWriteoffDocument()
|
|
| Method Summary | |
|---|---|
protected void |
addReceivableGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
boolean hasClaimOnCashOffset,
org.kuali.rice.kns.util.KualiDecimal amount)
This method creates the receivable GLPEs for customer invoice details using the remaining amount |
protected void |
addSalesTaxGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
boolean hasWriteoffTaxClaimOnCashOffset,
org.kuali.rice.kns.util.KualiDecimal amount)
|
protected void |
addWriteoffGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
boolean hasClaimOnCashOffset,
org.kuali.rice.kns.util.KualiDecimal amount)
This method adds writeoff GLPE's for the customer invoice details using the remaining amount. |
boolean |
answerSplitNodeQuestion(String nodeName)
Answers true when invoice write off amount is greater than default approved amount ($50???) |
void |
clearInitFields()
Clear out the initially populated fields. |
void |
doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)
When document is processed do the following: 1) Apply amounts to writeoff invoice 2) Mark off invoice indiciator |
boolean |
generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)
Creates any GeneralLedgerPostingEntry's that are based on a document, not those based on GeneralLedgerPendingEntrySourceDetail entries |
boolean |
generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
GeneralLedgerPendingEntrySequenceHelper sequenceHelper)
This method creates the following GLPE's for the customer invoice writeoff 1. |
Account |
getAccount()
|
String |
getAccountNumber()
|
AccountsReceivableDocumentHeader |
getAccountsReceivableDocumentHeader()
|
Chart |
getChartOfAccounts()
|
String |
getChartOfAccountsCode()
|
protected org.kuali.rice.kns.util.KualiDecimal |
getCustomerInvoiceDetailOpenPretaxAmount(CustomerInvoiceDetail customerInvoiceDetail)
|
List<CustomerInvoiceDetail> |
getCustomerInvoiceDetailsForWriteoff()
This method returns all the applicable invoice details for writeoff. |
CustomerInvoiceDocument |
getCustomerInvoiceDocument()
|
String |
getCustomerNote()
Gets the customerNote attribute. |
String |
getFinancialDocumentReferenceInvoiceNumber()
|
ObjectCode |
getFinancialObject()
|
String |
getFinancialObjectCode()
|
SubObjectCode |
getFinancialSubObject()
|
String |
getFinancialSubObjectCode()
|
org.kuali.rice.kns.util.KualiDecimal |
getGeneralLedgerPendingEntryAmountForDetail(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail)
A method to determine what the actual amount, based off of a GeneralLedgerPendingEntrySourceDetail, should be for the resultant GeneralLedgerPendingEntry |
List<GeneralLedgerPendingEntrySourceDetail> |
getGeneralLedgerPendingEntrySourceDetails()
Returns a list of any GeneralLedgerPostables this helper has, to create GeneralLedgerPendingEntries |
org.kuali.rice.kns.util.KualiDecimal |
getInvoiceWriteoffAmount()
This method returns the total amount to be written off |
String |
getOrganizationReferenceIdentifier()
|
ProjectCode |
getProject()
|
String |
getProjectCode()
|
String |
getStatusCode()
|
SubAccount |
getSubAccount()
|
String |
getSubAccountNumber()
|
org.kuali.rice.kns.util.KualiDecimal |
getTotalDollarAmount()
This method returns the total dollar amount for the document. |
List<Long> |
getWorkflowEngineDocumentIdsToLock()
|
void |
initiateDocument()
Initializes the values for a new document. |
boolean |
isDebit(GeneralLedgerPendingEntrySourceDetail postable)
This method determines if the passed in GeneralLedgerPendingEntrySourceDetail is a debit or not. |
void |
populateCustomerNote()
|
void |
prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)
do all the calculations before the document gets saved gets called for 'Submit', 'Save', and 'Blanket Approved' |
void |
setAccount(Account account)
|
void |
setAccountNumber(String accountNumber)
|
void |
setAccountsReceivableDocumentHeader(AccountsReceivableDocumentHeader accountsReceivableDocumentHeader)
|
void |
setChartOfAccounts(Chart chartOfAccounts)
|
void |
setChartOfAccountsCode(String chartOfAccountsCode)
|
void |
setCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument)
|
void |
setCustomerNote(String customerNote)
Sets the customerNote attribute value. |
void |
setFinancialDocumentReferenceInvoiceNumber(String financialDocumentReferenceInvoiceNumber)
|
void |
setFinancialObject(ObjectCode financialObject)
|
void |
setFinancialObjectCode(String financialObjectCode)
|
void |
setFinancialSubObject(SubObjectCode financialSubObject)
|
void |
setFinancialSubObjectCode(String financialSubObjectCode)
|
void |
setInvoiceWriteoffAmount(org.kuali.rice.kns.util.KualiDecimal invoiceWriteoffAmount)
|
void |
setOrganizationReferenceIdentifier(String organizationReferenceIdentifier)
|
void |
setProject(ProjectCode project)
|
void |
setProjectCode(String projectCode)
|
void |
setStatusCode(String statusCode)
|
void |
setSubAccount(SubAccount subAccount)
|
void |
setSubAccountNumber(String subAccountNumber)
|
| 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, prepareForSave, 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, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getXmlForRouteReport, logErrors, populateDocumentForRouting, postProcessSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setPessimisticLocks, toString, toStringBuilder, toStringMapper, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization |
| Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase |
|---|
addNote, afterDelete, afterInsert, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, 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.GeneralLedgerPendingEntrySource |
|---|
addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getPostingYear |
| 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, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization |
| 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 |
| Field Detail |
|---|
protected static final String REQUIRES_APPROVAL_NODE
protected String chartOfAccountsCode
protected String accountNumber
protected String subAccountNumber
protected String financialObjectCode
protected String financialSubObjectCode
protected String projectCode
protected String organizationReferenceIdentifier
protected String financialDocumentReferenceInvoiceNumber
protected String statusCode
protected String customerNote
protected Account account
protected Chart chartOfAccounts
protected SubAccount subAccount
protected ObjectCode financialObject
protected SubObjectCode financialSubObject
protected ProjectCode project
protected CustomerInvoiceDocument customerInvoiceDocument
protected AccountsReceivableDocumentHeader accountsReceivableDocumentHeader
protected org.kuali.rice.kns.util.KualiDecimal invoiceWriteoffAmount
| Constructor Detail |
|---|
public CustomerInvoiceWriteoffDocument()
| Method Detail |
|---|
public AccountsReceivableDocumentHeader getAccountsReceivableDocumentHeader()
public void setAccountsReceivableDocumentHeader(AccountsReceivableDocumentHeader accountsReceivableDocumentHeader)
public String getChartOfAccountsCode()
public void setChartOfAccountsCode(String chartOfAccountsCode)
public String getAccountNumber()
public void setAccountNumber(String accountNumber)
public String getSubAccountNumber()
public void setSubAccountNumber(String subAccountNumber)
public String getFinancialObjectCode()
public void setFinancialObjectCode(String financialObjectCode)
public String getFinancialSubObjectCode()
public void setFinancialSubObjectCode(String financialSubObjectCode)
public String getProjectCode()
public void setProjectCode(String projectCode)
public String getOrganizationReferenceIdentifier()
public void setOrganizationReferenceIdentifier(String organizationReferenceIdentifier)
public String getFinancialDocumentReferenceInvoiceNumber()
public void setFinancialDocumentReferenceInvoiceNumber(String financialDocumentReferenceInvoiceNumber)
public Account getAccount()
public void setAccount(Account account)
public Chart getChartOfAccounts()
public void setChartOfAccounts(Chart chartOfAccounts)
public SubAccount getSubAccount()
public void setSubAccount(SubAccount subAccount)
public ObjectCode getFinancialObject()
public void setFinancialObject(ObjectCode financialObject)
public SubObjectCode getFinancialSubObject()
public void setFinancialSubObject(SubObjectCode financialSubObject)
public ProjectCode getProject()
public void setProject(ProjectCode project)
public CustomerInvoiceDocument getCustomerInvoiceDocument()
public void setCustomerInvoiceDocument(CustomerInvoiceDocument customerInvoiceDocument)
public List<CustomerInvoiceDetail> getCustomerInvoiceDetailsForWriteoff()
public org.kuali.rice.kns.util.KualiDecimal getInvoiceWriteoffAmount()
public void setInvoiceWriteoffAmount(org.kuali.rice.kns.util.KualiDecimal invoiceWriteoffAmount)
public String getStatusCode()
public void setStatusCode(String statusCode)
public void initiateDocument()
public void clearInitFields()
public List<Long> getWorkflowEngineDocumentIdsToLock()
getWorkflowEngineDocumentIdsToLock in interface org.kuali.rice.kns.document.DocumentgetWorkflowEngineDocumentIdsToLock in class org.kuali.rice.kns.document.DocumentBasepublic void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)
doRouteStatusChange in interface org.kuali.rice.kns.document.DocumentdoRouteStatusChange in class GeneralLedgerPostingDocumentBaseorg.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase#doRouteStatusChange()public void prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)
prepareForSave in interface org.kuali.rice.kns.document.DocumentprepareForSave in class GeneralLedgerPostingDocumentBaseDocument.prepareForSave(org.kuali.rice.kns.rule.event.KualiDocumentEvent)public boolean generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)
GeneralLedgerPendingEntrySource
generateDocumentGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySourcesequenceHelper - a sequence helper for the method to create more general ledger pending entries
protected org.kuali.rice.kns.util.KualiDecimal getCustomerInvoiceDetailOpenPretaxAmount(CustomerInvoiceDetail customerInvoiceDetail)
public boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
GeneralLedgerPendingEntrySequenceHelper sequenceHelper)
generateGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySourceglpeSourceDetail - the source detail line to generate general ledger pending entries forsequenceHelper - the sequence helper which will assign sequence number to generated general ledger pending entries
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)
protected void addReceivableGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
boolean hasClaimOnCashOffset,
org.kuali.rice.kns.util.KualiDecimal amount)
poster - sequenceHelper - postable - explicitEntry -
protected void addWriteoffGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
boolean hasClaimOnCashOffset,
org.kuali.rice.kns.util.KualiDecimal amount)
poster - sequenceHelper - postable - explicitEntry -
protected void addSalesTaxGLPEs(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
boolean hasWriteoffTaxClaimOnCashOffset,
org.kuali.rice.kns.util.KualiDecimal amount)
public org.kuali.rice.kns.util.KualiDecimal getGeneralLedgerPendingEntryAmountForDetail(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail)
GeneralLedgerPendingEntrySource
getGeneralLedgerPendingEntryAmountForDetail in interface GeneralLedgerPendingEntrySourceglpeSourceDetail - the detail line from the general ledger pending entry source to find an amount for
public List<GeneralLedgerPendingEntrySourceDetail> getGeneralLedgerPendingEntrySourceDetails()
GeneralLedgerPendingEntrySource
getGeneralLedgerPendingEntrySourceDetails in interface GeneralLedgerPendingEntrySourcepublic boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)
GeneralLedgerPendingEntrySource
isDebit in interface GeneralLedgerPendingEntrySourcepublic org.kuali.rice.kns.util.KualiDecimal getTotalDollarAmount()
AmountTotaling
getTotalDollarAmount in interface AmountTotalingpublic String getCustomerNote()
public void setCustomerNote(String customerNote)
customerNote - The customerNote to set.public void populateCustomerNote()
public boolean answerSplitNodeQuestion(String nodeName)
throws UnsupportedOperationException
answerSplitNodeQuestion in interface FinancialSystemTransactionalDocumentanswerSplitNodeQuestion in class FinancialSystemTransactionalDocumentBaseUnsupportedOperationExceptionFinancialSystemTransactionalDocumentBase.answerSplitNodeQuestion(java.lang.String)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||