org.kuali.ole.select.document

Class OleDisbursementVoucherDocument

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.DisbursementVoucherDocument

org.kuali.ole.select.document.OleDisbursementVoucherDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, AccountingDocument, AmountTotaling, 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

public class OleDisbursementVoucherDocument
extends DisbursementVoucherDocument

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected OleDisbursementVoucherPayeeDetail	dvPayeeDetail
protected static String	HAS_CLEARING_ACCOUNT_TYPE_SPLIT

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

bank, businessObjectService, campusCode, cancelDate, dateTimeService, DEFAULT_EMPLOYEE_ADDRESS_TYPE_PARAMETER_NAME, disbExcptAttachedIndicator, DISBURSEMENT_VOUCHER_TYPE, disbursementVoucherCheckDate, disbursementVoucherCheckNbr, disbursementVoucherDocumentationLocationCode, disbursementVoucherDueDate, disbursementVoucherExtractService, disbVchrAttachmentCode, disbVchrBankCode, disbVchrCheckStubText, disbVchrCheckTotalAmount, disbVchrContactEmailId, disbVchrContactPersonName, disbVchrContactPhoneNumber, disbVchrDocumentationLoc, disbVchrForeignCurrencyInd, disbVchrPayeeChangedInd, disbVchrPayeeTaxControlCode, disbVchrPayeeW9CompleteCode, disbVchrPaymentMethodCode, disbVchrPdpBankCode, disbVchrSpecialHandlingCode, DOCUMENT_REQUIRES_SEPARATION_OF_DUTIES, DOCUMENT_REQUIRES_TAX_REVIEW_SPLIT, DOCUMENT_REQUIRES_TRAVEL_REVIEW_SPLIT, dvCheckStubOverflowCode, dvNonEmployeeTravel, dvNonResidentAlienTax, dvPreConferenceDetail, dvPymentReasonService, dvWireTransfer, editW9W8BENbox, exceptionIndicator, extractDate, financialDocument, finDocNextRegistrantLineNbr, identityManagementService, immediatePaymentIndicator, LOG, paidDate, parameterService, PAYEE_IS_PURCHASE_ORDER_VENDOR_SPLIT, payeeAssigned, PAYMENT_REASONS_REQUIRING_TAX_REVIEW_PARAMETER_NAME, paymentMethodId, personService, PURCHASE_ORDER_VENDOR_TYPE, SEPARATION_OF_DUTIES_PARAMETER_NAME, TAX_CONTROL_BACKUP_HOLDING, TAX_CONTROL_HOLD_PAYMENTS, USE_DEFAULT_EMPLOYEE_ADDRESS_PARAMETER_NAME, vendorService

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, 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
OleDisbursementVoucherDocument() Default no-arg constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSourceAccountingLine(SourceAccountingLine line) This implementation sets the sequence number appropriately for the passed in source accounting line using the value that has been stored in the nextSourceLineNumber variable, adds the accounting line to the list that is aggregated by this object, and then handles incrementing the nextSourceLineNumber variable for you.
boolean	answerSplitNodeQuestion(String nodeName) Provides answers to the following splits: PayeeIsPurchaseOrderVendor RequiresTaxReview RequiresTravelReview HasClearingAccountType HasPaymentMethod
protected String	buildDocumentTitle(String title) build document title based on the properties of current document
protected void	cleanDocumentData() Clears information that might have been entered for sub tables, but because of changes to the document is longer needed and should not be persisted.
protected void	clearSpecialHandling() Clears all set special handling fields
OleDisbursementVoucherPayeeDetail	getDvPayeeDetail()
String	getInvoiceNumber()
OleDisbursementVoucherAccountingLine	getSourceAccountingLine(int index) This implementation is coupled tightly with some underlying issues that the Struts PojoProcessor plugin has with how objects get instantiated within lists.
Class	getSourceAccountingLineClass() Returns the default Source accounting line class.Dollar
List<OleDisbursementVoucherAccountingLine>	getSourceAccountingLines() This method returns a list of target accounting lines.
String	getVendorAliasName()
void	initiateDocument() generic, shared logic used to initiate a dv document
void	populateDocumentForRouting() This method is overridden to populate some local variables that are not persisted to the database.
void	prepareForSave() If the document has a total amount, call method on document to get the total and set in doc header.
void	setDvPayeeDetail(DisbursementVoucherPayeeDetail dvPayeeDetail)
void	setInvoiceNumber(String invoiceNumber)
void	setSourceAccountingLines(List sourceLines) This method sets the list of source accounting lines for this document.
void	setVendorAliasName(String vendorAliasName)
void	templateVendor(VendorDetail vendor, VendorAddress vendorAddress) Convenience method to set dv payee detail fields based on a given vendor.

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

addDvPrePaidRegistrantLine, buildListOfDeletionAwareLists, customizeExplicitGeneralLedgerPendingEntry, doRouteStatusChange, findAddressByType, generateDocumentBankOffsetEntries, generateDocumentGeneralLedgerPendingEntries, getAllPriorApprovers, getBank, getCampusCode, getCancelDate, getDisbursementVoucherCheckDate, getDisbursementVoucherCheckNbr, getDisbursementVoucherDocumentationLocationCode, getDisbursementVoucherDocumentationLocationName, getDisbursementVoucherDueDate, getDisbursementVoucherExtractService, getDisbursementVoucherPdpStatus, getDisbVchrBankCode, getDisbVchrCheckStubText, getDisbVchrCheckTotalAmount, getDisbVchrContactEmailId, getDisbVchrContactPersonName, getDisbVchrContactPhoneNumber, getDisbVchrDocumentationLoc, getDisbVchrPayeeTaxControlCode, getDisbVchrPayeeW9CompleteCode, getDisbVchrPaymentMethodCode, getDisbVchrPaymentMethodName, getDisbVchrPdpBankCode, getDocumentTitle, getDvCheckStubOverflowCode, getDvNonEmployeeTravel, getDvNonResidentAlienTax, getDvPreConferenceDetail, getDvPymentReasonService, getDvWireTransfer, getExtractDate, getFinancialDocument, getFinDocNextRegistrantLineNbr, getIdentityManagementService, getNonDefaultAddress, getPaidDate, getParameterService, getPaymentDetailDocumentType, getPaymentMethod, getPaymentMethodId, getPendingLedgerEntriesForSufficientFundsChecking, getPersonEntityEntityType, getPersonService, getTotalDollarAmount, getVendorService, isDebit, isDisbExcptAttachedIndicator, isDisbVchrAttachmentCode, isDisbVchrForeignCurrencyInd, isDisbVchrPayeeChangedInd, isDisbVchrSpecialHandlingCode, isEditW9W8BENbox, isExceptionIndicator, isImmediatePaymentIndicator, isPayeeAssigned, isPayeePurchaseOrderVendor, isPayeePurchaseOrderVendorHasWithholding, isSeparationOfDutiesReviewRequired, isTaxReviewRequired, isTravelReviewRequired, processWireChargeCreditEntries, processWireChargeDebitEntries, retrieveWireCharge, setBank, setCampusCode, setCancelDate, setDisbExcptAttachedIndicator, setDisbursementVoucherCheckDate, setDisbursementVoucherCheckNbr, setDisbursementVoucherDocumentationLocationCode, setDisbursementVoucherDocumentationLocationName, setDisbursementVoucherDueDate, setDisbursementVoucherPdpStatus, setDisbVchrAttachmentCode, setDisbVchrBankCode, setDisbVchrCheckStubText, setDisbVchrCheckTotalAmount, setDisbVchrContactEmailId, setDisbVchrContactPersonName, setDisbVchrContactPhoneNumber, setDisbVchrDocumentationLoc, setDisbVchrForeignCurrencyInd, setDisbVchrPayeeChangedInd, setDisbVchrPayeeTaxControlCode, setDisbVchrPayeeW9CompleteCode, setDisbVchrPaymentMethodCode, setDisbVchrPaymentMethodName, setDisbVchrPdpBankCode, setDisbVchrSpecialHandlingCode, setDvCheckStubOverflowCode, setDvNonEmployeeTravel, setDvNonResidentAlienTax, setDvPreConferenceDetail, setDvWireTransfer, setEditW9W8BENbox, setExceptionIndicator, setExtractDate, setFinancialDocument, setFinDocNextRegistrantLineNbr, setIdentityManagementService, setImmediatePaymentIndicator, setPaidDate, setPayeeAssigned, setPaymentMethod, setPaymentMethodId, shouldClearSpecialHandling, templateEmployee, toCopy

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

addTargetAccountingLine, buildAccountingLineMap, copyAccountingLines, customizeOffsetGeneralLedgerPendingEntry, generateEvents, generateGeneralLedgerPendingEntries, generateSaveEvents, getAccountingLineParser, getDataDictionaryEntry, getDocumentClassForAccountingLineValueAllowedValidation, getEntryValue, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getNextSourceLineNumber, getNextTargetLineNumber, getPersistedSourceAccountingLinesForComparison, getPersistedTargetAccountingLinesForComparison, getSourceAccountingLineEntryName, getSourceAccountingLinesForComparison, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesForComparison, getTargetAccountingLinesSectionTitle, getTargetTotal, isDocumentFinalOrProcessed, prepareForSave, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setTargetAccountingLines, toErrorCorrection, updatePostingYearForAccountingLines

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

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, documentPerformsSufficientFundsCheck, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, 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

doRouteLevelChange, getApplicationDocumentStatus, getBusinessObjectService, getFinancialSystemDocumentHeader, getFinancialSystemDocumentService, 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, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, postLoad, postProcessSave, 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.ole.sys.document.GeneralLedgerPostingDocument

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, 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

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, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, postProcessSave, 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

HAS_CLEARING_ACCOUNT_TYPE_SPLIT

protected static final String HAS_CLEARING_ACCOUNT_TYPE_SPLIT

See Also:

Constant Field Values

dvPayeeDetail

protected OleDisbursementVoucherPayeeDetail dvPayeeDetail

Constructor Detail

OleDisbursementVoucherDocument

public OleDisbursementVoucherDocument()

Default no-arg constructor.

Method Detail

getVendorAliasName

public String getVendorAliasName()

setVendorAliasName

public void setVendorAliasName(String vendorAliasName)

getInvoiceNumber

public String getInvoiceNumber()

setInvoiceNumber

public void setInvoiceNumber(String invoiceNumber)

getDvPayeeDetail

public OleDisbursementVoucherPayeeDetail getDvPayeeDetail()

Overrides:

getDvPayeeDetail in class DisbursementVoucherDocument

Returns:

Returns the dvPayeeDetail.

setDvPayeeDetail

public void setDvPayeeDetail(DisbursementVoucherPayeeDetail dvPayeeDetail)

Overrides:

setDvPayeeDetail in class DisbursementVoucherDocument

Parameters:

dvPayeeDetail - The dvPayeeDetail to set.

prepareForSave

public void prepareForSave()

Description copied from class: FinancialSystemTransactionalDocumentBase

If the document has a total amount, call method on document to get the total and set in doc header.

Specified by:

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

Overrides:

prepareForSave in class DisbursementVoucherDocument

See Also:

org.kuali.rice.kns.document.Document#prepareForSave()

clearSpecialHandling

protected void clearSpecialHandling()

Clears all set special handling fields

Overrides:

clearSpecialHandling in class DisbursementVoucherDocument

cleanDocumentData

protected void cleanDocumentData()

Clears information that might have been entered for sub tables, but because of changes to the document is longer needed and should not be persisted.

Overrides:

cleanDocumentData in class DisbursementVoucherDocument

buildDocumentTitle

protected String buildDocumentTitle(String title)

build document title based on the properties of current document

Overrides:

buildDocumentTitle in class DisbursementVoucherDocument

Parameters:

the - default document title

Returns:

the combine information of the given title and additional payment indicators

templateVendor

public void templateVendor(VendorDetail vendor,
                  VendorAddress vendorAddress)

Convenience method to set dv payee detail fields based on a given vendor.

Overrides:

templateVendor in class DisbursementVoucherDocument

Parameters:

vendor -

populateDocumentForRouting

public void populateDocumentForRouting()

This method is overridden to populate some local variables that are not persisted to the database. These values need to be computed and saved to the DV Payee Detail BO so they can be serialized to XML for routing. Some of the routing rules rely on these variables.

Specified by:

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

Overrides:

populateDocumentForRouting in class DisbursementVoucherDocument

See Also:

org.kuali.rice.kns.document.DocumentBase#populateDocumentForRouting()

initiateDocument

public void initiateDocument()

generic, shared logic used to initiate a dv document

Overrides:

initiateDocument in class DisbursementVoucherDocument

addSourceAccountingLine

public void addSourceAccountingLine(SourceAccountingLine line)

This implementation sets the sequence number appropriately for the passed in source accounting line using the value that has been stored in the nextSourceLineNumber variable, adds the accounting line to the list that is aggregated by this object, and then handles incrementing the nextSourceLineNumber variable for you.

Specified by:

addSourceAccountingLine in interface AccountingDocument

Overrides:

addSourceAccountingLine in class AccountingDocumentBase

See Also:

AccountingDocument.addSourceAccountingLine(org.kuali.ole.sys.businessobject.SourceAccountingLine)

getSourceAccountingLine

public OleDisbursementVoucherAccountingLine getSourceAccountingLine(int index)

This implementation is coupled tightly with some underlying issues that the Struts PojoProcessor plugin has with how objects get instantiated within lists. The first three lines are required otherwise when the PojoProcessor tries to automatically inject values into the list, it will get an index out of bounds error if the instance at an index is being called and prior instances at indices before that one are not being instantiated. So changing the code below will cause adding lines to break if you add more than one item to the list.

Specified by:

getSourceAccountingLine in interface AccountingDocument

Overrides:

getSourceAccountingLine in class AccountingDocumentBase

Returns:

The source accounting line at the specified index.

See Also:

AccountingDocument.getSourceAccountingLine(int)

getSourceAccountingLineClass

public Class getSourceAccountingLineClass()

Returns the default Source accounting line class.Dollar

Specified by:

getSourceAccountingLineClass in interface AccountingDocument

Overrides:

getSourceAccountingLineClass in class AccountingDocumentBase

See Also:

AccountingDocument.getSourceAccountingLineClass()

getSourceAccountingLines

public List<OleDisbursementVoucherAccountingLine> getSourceAccountingLines()

Description copied from interface: AccountingDocument

This method returns a list of target accounting lines.

Specified by:

getSourceAccountingLines in interface AccountingDocument

Overrides:

getSourceAccountingLines in class AccountingDocumentBase

Returns:

The list of source accounting lines.

See Also:

AccountingDocument.getSourceAccountingLines()

setSourceAccountingLines

public void setSourceAccountingLines(List sourceLines)

Description copied from interface: AccountingDocument

This method sets the list of source accounting lines for this document.

Specified by:

setSourceAccountingLines in interface AccountingDocument

Overrides:

setSourceAccountingLines in class AccountingDocumentBase

See Also:

AccountingDocument.setSourceAccountingLines(java.util.List)

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Provides answers to the following splits: PayeeIsPurchaseOrderVendor RequiresTaxReview RequiresTravelReview HasClearingAccountType HasPaymentMethod

Specified by:

answerSplitNodeQuestion in interface FinancialSystemDocument

Overrides:

answerSplitNodeQuestion in class DisbursementVoucherDocument

Throws:

UnsupportedOperationException

See Also:

FinancialSystemTransactionalDocumentBase.answerSplitNodeQuestion(String)