org.kuali.kfs.fp.document
Class DisbursementVoucherDocument

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

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, AccountingDocument, AmountTotaling, 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 DisbursementVoucherDocument
extends AccountingDocumentBase
implements org.kuali.rice.kns.document.Copyable, AmountTotaling

This is the business object that represents the DisbursementVoucher document in Kuali.

See Also:

Serialized Form

Field Summary

protected Bank	bank
protected static org.kuali.rice.kns.service.BusinessObjectService	businessObjectService
protected String	campusCode
protected Date	cancelDate
protected static org.kuali.rice.kns.service.DateTimeService	dateTimeService
protected static String	DEFAULT_EMPLOYEE_ADDRESS_TYPE_PARAMETER_NAME
protected boolean	disbExcptAttachedIndicator
protected Timestamp	disbursementVoucherCheckDate
protected String	disbursementVoucherCheckNbr
protected String	disbursementVoucherDocumentationLocationCode
protected Date	disbursementVoucherDueDate
protected boolean	disbVchrAttachmentCode
protected String	disbVchrBankCode
protected String	disbVchrCheckStubText
protected org.kuali.rice.kns.util.KualiDecimal	disbVchrCheckTotalAmount
protected String	disbVchrContactEmailId
protected String	disbVchrContactPersonName
protected String	disbVchrContactPhoneNumber
protected DisbursementVoucherDocumentationLocation	disbVchrDocumentationLoc
protected boolean	disbVchrForeignCurrencyInd
protected boolean	disbVchrPayeeChangedInd
protected String	disbVchrPayeeTaxControlCode
protected boolean	disbVchrPayeeW9CompleteCode
protected String	disbVchrPaymentMethodCode
protected String	disbVchrPdpBankCode
protected boolean	disbVchrSpecialHandlingCode
protected static String	DOCUMENT_REQUIRES_TAX_REVIEW_SPLIT
protected static String	DOCUMENT_REQUIRES_TRAVEL_REVIEW_SPLIT
protected boolean	dvCheckStubOverflowCode
protected DisbursementVoucherNonEmployeeTravel	dvNonEmployeeTravel
protected DisbursementVoucherNonResidentAlienTax	dvNonResidentAlienTax
protected DisbursementVoucherPayeeDetail	dvPayeeDetail
protected DisbursementVoucherPreConferenceDetail	dvPreConferenceDetail
protected static DisbursementVoucherPaymentReasonService	dvPymentReasonService
protected DisbursementVoucherWireTransfer	dvWireTransfer
protected boolean	editW9W8BENbox
protected boolean	exceptionIndicator
protected Date	extractDate
protected org.kuali.rice.kns.bo.DocumentHeader	financialDocument
protected Integer	finDocNextRegistrantLineNbr
protected static org.kuali.rice.kim.service.IdentityManagementService	identityManagementService
protected static org.apache.log4j.Logger	LOG
protected Date	paidDate
protected static org.kuali.rice.kns.service.ParameterService	parameterService
protected static String	PAYEE_IS_PURCHASE_ORDER_VENDOR_SPLIT
protected boolean	payeeAssigned
protected static String	PAYMENT_REASONS_REQUIRING_TAX_REVIEW_PARAMETER_NAME
protected static org.kuali.rice.kim.service.PersonService<org.kuali.rice.kim.bo.Person>	personService
protected static String	PURCHASE_ORDER_VENDOR_TYPE
protected static String	TAX_CONTROL_BACKUP_HOLDING
protected static String	TAX_CONTROL_HOLD_PAYMENTS
protected static String	USE_DEFAULT_EMPLOYEE_ADDRESS_PARAMETER_NAME
protected static VendorService	vendorService

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

DisbursementVoucherDocument()
Default no-arg constructor.

Method Summary

void	addDvPrePaidRegistrantLine(DisbursementVoucherPreConferenceRegistrant line) Adds a dv pre-paid registrant line
boolean	answerSplitNodeQuestion(String nodeName) Provides answers to the following splits: PayeeIsPurchaseOrderVendor RequiresTaxReview RequiresTravelReview
protected String	buildDocumentTitle(String title) build document title based on the properties of current document
List	buildListOfDeletionAwareLists()
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
void	customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine, GeneralLedgerPendingEntry explicitEntry) Override to change the doc type based on payment method.
protected org.kuali.rice.kim.bo.entity.KimEntityAddress	findAddressByType(List<? extends org.kuali.rice.kim.bo.entity.KimEntityAddress> addresses, String addressType) Given a List of KimEntityAddress and an address type, finds the address in the List with the given type (or null if no matching KimEntityAddress is found)
boolean	generateDocumentBankOffsetEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) If bank specification is enabled generates bank offsetting entries for the document amount
boolean	generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Return true if GLPE's are generated successfully (i.e.
Bank	getBank() Gets the bank attribute.
protected org.kuali.rice.kns.service.BusinessObjectService	getBusinessObjectService()
String	getCampusCode() Gets the campusCode attribute.
Date	getCancelDate() Gets the cancelDate attribute.
Timestamp	getDisbursementVoucherCheckDate() Gets the disbursementVoucherCheckDate attribute.
String	getDisbursementVoucherCheckNbr() Gets the disbursementVoucherCheckNbr attribute.
String	getDisbursementVoucherDocumentationLocationCode() Gets the disbursementVoucherDocumentationLocationCode attribute.
String	getDisbursementVoucherDocumentationLocationName() Returns the name associated with the documentation location name
Date	getDisbursementVoucherDueDate() Gets the disbursementVoucherDueDate attribute.
String	getDisbursementVoucherPdpStatus() Based on which pdp dates are present (extract, paid, canceled), determines a String for the status
String	getDisbVchrBankCode() Gets the disbVchrBankCode attribute.
String	getDisbVchrCheckStubText() Gets the disbVchrCheckStubText attribute.
org.kuali.rice.kns.util.KualiDecimal	getDisbVchrCheckTotalAmount() Gets the disbVchrCheckTotalAmount attribute.
String	getDisbVchrContactEmailId() Gets the disbVchrContactEmailId attribute.
String	getDisbVchrContactPersonName() Gets the disbVchrContactPersonName attribute.
String	getDisbVchrContactPhoneNumber() Gets the disbVchrContactPhoneNumber attribute.
DisbursementVoucherDocumentationLocation	getDisbVchrDocumentationLoc() Gets the disbVchrDocumentationLoc attribute.
String	getDisbVchrPayeeTaxControlCode() Gets the disbVchrPayeeTaxControlCode attribute.
boolean	getDisbVchrPayeeW9CompleteCode() Gets the disbVchrPayeeW9CompleteCode attribute.
String	getDisbVchrPaymentMethodCode() Gets the disbVchrPaymentMethodCode attribute.
String	getDisbVchrPaymentMethodName() Returns the name associated with the payment method code
String	getDisbVchrPdpBankCode() Gets the disbVchrPdpBankCode attribute.
String	getDocumentTitle()
boolean	getDvCheckStubOverflowCode() Gets the dvCheckStubOverflowCode attribute.
DisbursementVoucherNonEmployeeTravel	getDvNonEmployeeTravel()
DisbursementVoucherNonResidentAlienTax	getDvNonResidentAlienTax()
DisbursementVoucherPayeeDetail	getDvPayeeDetail()
DisbursementVoucherPreConferenceDetail	getDvPreConferenceDetail()
DisbursementVoucherPaymentReasonService	getDvPymentReasonService() Gets the dvPymentReasonService attribute.
DisbursementVoucherWireTransfer	getDvWireTransfer()
Date	getExtractDate() Gets the extractDate attribute.
org.kuali.rice.kns.bo.DocumentHeader	getFinancialDocument() Gets the financialDocument attribute.
Integer	getFinDocNextRegistrantLineNbr() Gets the finDocNextRegistrantLineNbr attribute.
static org.kuali.rice.kim.service.IdentityManagementService	getIdentityManagementService() Gets the identityManagementService attribute.
protected org.kuali.rice.kim.bo.entity.KimEntityAddress	getNonDefaultAddress(org.kuali.rice.kim.bo.Person employee) Finds the address for the given employee, matching the type in the KFS-FP / Disbursement Voucher/ DEFAULT_EMPLOYEE_ADDRESS_TYPE parameter, to use as the address for the employee
Date	getPaidDate() Gets the paidDate attribute.
protected org.kuali.rice.kns.service.ParameterService	getParameterService()
List<GeneralLedgerPendingEntry>	getPendingLedgerEntriesForSufficientFundsChecking() This method will return only PLEs that should be checked for SF.
protected org.kuali.rice.kim.bo.entity.KimEntityEntityType	getPersonEntityEntityType(org.kuali.rice.kim.bo.entity.dto.KimEntityInfo entityInfo) Someday this method will be in Rice.
protected org.kuali.rice.kim.service.PersonService<org.kuali.rice.kim.bo.Person>	getPersonService()
org.kuali.rice.kns.util.KualiDecimal	getTotalDollarAmount() Returns check total.
protected VendorService	getVendorService()
void	initiateDocument() generic, shared logic used to initiate a dv document
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) Returns true if accounting line debit
boolean	isDisbExcptAttachedIndicator()
boolean	isDisbVchrAttachmentCode() Gets the disbVchrAttachmentCode attribute.
boolean	isDisbVchrForeignCurrencyInd() Gets the disbVchrForeignCurrencyInd attribute.
boolean	isDisbVchrPayeeChangedInd() Gets the disbVchrPayeeChangedInd attribute.
boolean	isDisbVchrSpecialHandlingCode() Gets the disbVchrSpecialHandlingCode attribute.
boolean	isEditW9W8BENbox() Gets the editW9W8BENbox attribute.
boolean	isExceptionIndicator()
boolean	isPayeeAssigned() Gets the payeeAssigned attribute.
protected boolean	isPayeePurchaseOrderVendor()
protected boolean	isPayeePurchaseOrderVendorHasWithholding()
protected boolean	isTaxReviewRequired() Tax review is required under the following circumstances: the payee was an employee the payee was a non-resident alien vendor the tax control code = "B" or "H" the payment reason code was "D" the payment reason code was "M" and the campus was listed in the CAMPUSES_TAXED_FOR_MOVING_REIMBURSEMENTS_PARAMETER_NAME parameter
boolean	isTravelReviewRequired() Travel review is required under the following circumstances: payment reason code is "P" or "N"
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.
protected void	processWireChargeCreditEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper, WireCharge wireCharge, GeneralLedgerPendingEntry chargeEntry) Builds an explicit and offset for the wire charge credit.
protected GeneralLedgerPendingEntry	processWireChargeDebitEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper, WireCharge wireCharge) Builds an explicit and offset for the wire charge debit.
protected WireCharge	retrieveWireCharge() Retrieves the wire transfer information for the current fiscal year.
void	setBank(Bank bank) Sets the bank attribute value.
void	setCampusCode(String campusCode) Sets the campusCode attribute.
void	setCancelDate(Date cancelDate) Sets the cancelDate attribute value.
void	setDisbExcptAttachedIndicator(boolean disbExcptAttachedIndicator)
void	setDisbursementVoucherCheckDate(Timestamp disbursementVoucherCheckDate) Sets the disbursementVoucherCheckDate attribute.
void	setDisbursementVoucherCheckNbr(String disbursementVoucherCheckNbr) Sets the disbursementVoucherCheckNbr attribute.
void	setDisbursementVoucherDocumentationLocationCode(String disbursementVoucherDocumentationLocationCode) Sets the disbursementVoucherDocumentationLocationCode attribute.
void	setDisbursementVoucherDocumentationLocationName(String name) Deprecated. This method should not be used. There is no protected attribute to store this value. The associated getter retrieves the value remotely.
void	setDisbursementVoucherDueDate(Date disbursementVoucherDueDate) Sets the disbursementVoucherDueDate attribute.
void	setDisbursementVoucherPdpStatus(String status) Pretends to set the PDP status for this document
void	setDisbVchrAttachmentCode(boolean disbVchrAttachmentCode) Sets the disbVchrAttachmentCode attribute.
void	setDisbVchrBankCode(String disbVchrBankCode) Sets the disbVchrBankCode attribute value.
void	setDisbVchrCheckStubText(String disbVchrCheckStubText) Sets the disbVchrCheckStubText attribute.
void	setDisbVchrCheckTotalAmount(org.kuali.rice.kns.util.KualiDecimal disbVchrCheckTotalAmount) Sets the disbVchrCheckTotalAmount attribute.
void	setDisbVchrContactEmailId(String disbVchrContactEmailId) Sets the disbVchrContactEmailId attribute.
void	setDisbVchrContactPersonName(String disbVchrContactPersonName) Sets the disbVchrContactPersonName attribute.
void	setDisbVchrContactPhoneNumber(String disbVchrContactPhoneNumber) Sets the disbVchrContactPhoneNumber attribute.
void	setDisbVchrDocumentationLoc(DisbursementVoucherDocumentationLocation disbVchrDocumentationLoc) Deprecated.
void	setDisbVchrForeignCurrencyInd(boolean disbVchrForeignCurrencyInd) Sets the disbVchrForeignCurrencyInd attribute.
void	setDisbVchrPayeeChangedInd(boolean disbVchrPayeeChangedInd) Sets the disbVchrPayeeChangedInd attribute.
void	setDisbVchrPayeeTaxControlCode(String disbVchrPayeeTaxControlCode) Sets the disbVchrPayeeTaxControlCode attribute.
void	setDisbVchrPayeeW9CompleteCode(boolean disbVchrPayeeW9CompleteCode) Sets the disbVchrPayeeW9CompleteCode attribute.
void	setDisbVchrPaymentMethodCode(String disbVchrPaymentMethodCode) Sets the disbVchrPaymentMethodCode attribute.
void	setDisbVchrPaymentMethodName(String method) Deprecated. This method should not be used. There is no protected attribute to store this value. The associated getter retrieves the value remotely.
void	setDisbVchrPdpBankCode(String disbVchrPdpBankCode) Sets the disbVchrPdpBankCode attribute value.
void	setDisbVchrSpecialHandlingCode(boolean disbVchrSpecialHandlingCode) Sets the disbVchrSpecialHandlingCode attribute.
void	setDvCheckStubOverflowCode(boolean dvCheckStubOverflowCode) Sets the dvCheckStubOverflowCode attribute.
void	setDvNonEmployeeTravel(DisbursementVoucherNonEmployeeTravel dvNonEmployeeTravel)
void	setDvNonResidentAlienTax(DisbursementVoucherNonResidentAlienTax dvNonResidentAlienTax)
void	setDvPayeeDetail(DisbursementVoucherPayeeDetail dvPayeeDetail)
void	setDvPreConferenceDetail(DisbursementVoucherPreConferenceDetail dvPreConferenceDetail)
void	setDvWireTransfer(DisbursementVoucherWireTransfer dvWireTransfer)
void	setEditW9W8BENbox(boolean editW9W8BENbox) Sets the editW9W8BENbox attribute value.
void	setExceptionIndicator(boolean exceptionIndicator)
void	setExtractDate(Date extractDate) Sets the extractDate attribute value.
void	setFinancialDocument(org.kuali.rice.kns.bo.DocumentHeader financialDocument) Deprecated.
void	setFinDocNextRegistrantLineNbr(Integer finDocNextRegistrantLineNbr) Sets the finDocNextRegistrantLineNbr attribute.
static void	setIdentityManagementService(org.kuali.rice.kim.service.IdentityManagementService identityManagementService) Sets the identityManagementService attribute value.
void	setPaidDate(Date paidDate) Sets the paidDate attribute value.
void	setPayeeAssigned(boolean payeeAssigned) Sets the payeeAssigned attribute value.
protected boolean	shouldClearSpecialHandling() Determines if the special handling fields should be cleared, based on whether the special handling has been turned off and whether the current node is CAMPUS
protected boolean	taxedCampusForMovingReimbursements() Determines if the campus this DV is related to is taxed (and should get tax review routing) for moving reimbursements
void	templateEmployee(org.kuali.rice.kim.bo.Person employee) Convenience method to set dv payee detail fields based on a given Employee.
void	templateVendor(VendorDetail vendor, VendorAddress vendorAddress) Convenience method to set dv payee detail fields based on a given vendor.
void	toCopy() If we've copied, we need to update the posting period and year

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

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

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

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, documentPerformsSufficientFundsCheck, doRouteStatusChange, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, 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, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, 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, 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, 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, doRouteStatusChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, postProcessSave, processAfterRetrieve, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, 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

LOG

protected static org.apache.log4j.Logger LOG

PAYEE_IS_PURCHASE_ORDER_VENDOR_SPLIT

protected static final String PAYEE_IS_PURCHASE_ORDER_VENDOR_SPLIT

See Also:

Constant Field Values

PURCHASE_ORDER_VENDOR_TYPE

protected static final String PURCHASE_ORDER_VENDOR_TYPE

See Also:

Constant Field Values

DOCUMENT_REQUIRES_TAX_REVIEW_SPLIT

protected static final String DOCUMENT_REQUIRES_TAX_REVIEW_SPLIT

See Also:

Constant Field Values

DOCUMENT_REQUIRES_TRAVEL_REVIEW_SPLIT

protected static final String DOCUMENT_REQUIRES_TRAVEL_REVIEW_SPLIT

See Also:

Constant Field Values

PAYMENT_REASONS_REQUIRING_TAX_REVIEW_PARAMETER_NAME

protected static final String PAYMENT_REASONS_REQUIRING_TAX_REVIEW_PARAMETER_NAME

See Also:

Constant Field Values

USE_DEFAULT_EMPLOYEE_ADDRESS_PARAMETER_NAME

protected static final String USE_DEFAULT_EMPLOYEE_ADDRESS_PARAMETER_NAME

See Also:

Constant Field Values

DEFAULT_EMPLOYEE_ADDRESS_TYPE_PARAMETER_NAME

protected static final String DEFAULT_EMPLOYEE_ADDRESS_TYPE_PARAMETER_NAME

See Also:

Constant Field Values

TAX_CONTROL_BACKUP_HOLDING

protected static final String TAX_CONTROL_BACKUP_HOLDING

See Also:

Constant Field Values

TAX_CONTROL_HOLD_PAYMENTS

protected static final String TAX_CONTROL_HOLD_PAYMENTS

See Also:

Constant Field Values

personService

protected static transient org.kuali.rice.kim.service.PersonService<org.kuali.rice.kim.bo.Person> personService

parameterService

protected static transient org.kuali.rice.kns.service.ParameterService parameterService

vendorService

protected static transient VendorService vendorService

businessObjectService

protected static transient org.kuali.rice.kns.service.BusinessObjectService businessObjectService

dateTimeService

protected static transient org.kuali.rice.kns.service.DateTimeService dateTimeService

dvPymentReasonService

protected static transient DisbursementVoucherPaymentReasonService dvPymentReasonService

identityManagementService

protected static transient org.kuali.rice.kim.service.IdentityManagementService identityManagementService

finDocNextRegistrantLineNbr

protected Integer finDocNextRegistrantLineNbr

disbVchrContactPersonName

protected String disbVchrContactPersonName

disbVchrContactPhoneNumber

protected String disbVchrContactPhoneNumber

disbVchrContactEmailId

protected String disbVchrContactEmailId

disbursementVoucherDueDate

protected Date disbursementVoucherDueDate

disbVchrAttachmentCode

protected boolean disbVchrAttachmentCode

disbVchrSpecialHandlingCode

protected boolean disbVchrSpecialHandlingCode

disbVchrCheckTotalAmount

protected org.kuali.rice.kns.util.KualiDecimal disbVchrCheckTotalAmount

disbVchrForeignCurrencyInd

protected boolean disbVchrForeignCurrencyInd

disbursementVoucherDocumentationLocationCode

protected String disbursementVoucherDocumentationLocationCode

disbVchrCheckStubText

protected String disbVchrCheckStubText

dvCheckStubOverflowCode

protected boolean dvCheckStubOverflowCode

campusCode

protected String campusCode

disbVchrPayeeTaxControlCode

protected String disbVchrPayeeTaxControlCode

disbVchrPayeeChangedInd

protected boolean disbVchrPayeeChangedInd

disbursementVoucherCheckNbr

protected String disbursementVoucherCheckNbr

disbursementVoucherCheckDate

protected Timestamp disbursementVoucherCheckDate

disbVchrPayeeW9CompleteCode

protected boolean disbVchrPayeeW9CompleteCode

disbVchrPaymentMethodCode

protected String disbVchrPaymentMethodCode

exceptionIndicator

protected boolean exceptionIndicator

disbExcptAttachedIndicator

protected boolean disbExcptAttachedIndicator

extractDate

protected Date extractDate

paidDate

protected Date paidDate

cancelDate

protected Date cancelDate

disbVchrBankCode

protected String disbVchrBankCode

disbVchrPdpBankCode

protected String disbVchrPdpBankCode

payeeAssigned

protected boolean payeeAssigned

editW9W8BENbox

protected boolean editW9W8BENbox

financialDocument

protected org.kuali.rice.kns.bo.DocumentHeader financialDocument

disbVchrDocumentationLoc

protected DisbursementVoucherDocumentationLocation disbVchrDocumentationLoc

dvNonEmployeeTravel

protected DisbursementVoucherNonEmployeeTravel dvNonEmployeeTravel

dvNonResidentAlienTax

protected DisbursementVoucherNonResidentAlienTax dvNonResidentAlienTax

dvPayeeDetail

protected DisbursementVoucherPayeeDetail dvPayeeDetail

dvPreConferenceDetail

protected DisbursementVoucherPreConferenceDetail dvPreConferenceDetail

dvWireTransfer

protected DisbursementVoucherWireTransfer dvWireTransfer

bank

protected Bank bank

Constructor Detail

DisbursementVoucherDocument

public DisbursementVoucherDocument()

Default no-arg constructor.

Method Detail

getPendingLedgerEntriesForSufficientFundsChecking

public List<GeneralLedgerPendingEntry> getPendingLedgerEntriesForSufficientFundsChecking()

Description copied from interface: GeneralLedgerPostingDocument

This method will return only PLEs that should be checked for SF. Normally this will be all PLEs, but some docs (such as BA) have additional requirements.

Specified by:

getPendingLedgerEntriesForSufficientFundsChecking in interface GeneralLedgerPostingDocument

Overrides:

getPendingLedgerEntriesForSufficientFundsChecking in class GeneralLedgerPostingDocumentBase

Returns:

a list of sufficientfundsitems that do not have sufficient funds. It returns an empty list if there is sufficient funds for the entire document

See Also:

GeneralLedgerPostingDocumentBase.getPendingLedgerEntriesForSufficientFundsChecking()

getFinDocNextRegistrantLineNbr

public Integer getFinDocNextRegistrantLineNbr()

Gets the finDocNextRegistrantLineNbr attribute.

Returns:

Returns the finDocNextRegistrantLineNbr

setFinDocNextRegistrantLineNbr

public void setFinDocNextRegistrantLineNbr(Integer finDocNextRegistrantLineNbr)

Sets the finDocNextRegistrantLineNbr attribute.

Parameters:

finDocNextRegistrantLineNbr - The finDocNextRegistrantLineNbr to set.

getDisbVchrContactPersonName

public String getDisbVchrContactPersonName()

Gets the disbVchrContactPersonName attribute.

Returns:

Returns the disbVchrContactPersonName

setDisbVchrContactPersonName

public void setDisbVchrContactPersonName(String disbVchrContactPersonName)

Sets the disbVchrContactPersonName attribute.

Parameters:

disbVchrContactPersonName - The disbVchrContactPersonName to set.

getDisbVchrContactPhoneNumber

public String getDisbVchrContactPhoneNumber()

Gets the disbVchrContactPhoneNumber attribute.

Returns:

Returns the disbVchrContactPhoneNumber

setDisbVchrContactPhoneNumber

public void setDisbVchrContactPhoneNumber(String disbVchrContactPhoneNumber)

Sets the disbVchrContactPhoneNumber attribute.

Parameters:

disbVchrContactPhoneNumber - The disbVchrContactPhoneNumber to set.

getDisbVchrContactEmailId

public String getDisbVchrContactEmailId()

Gets the disbVchrContactEmailId attribute.

Returns:

Returns the disbVchrContactEmailId

setDisbVchrContactEmailId

public void setDisbVchrContactEmailId(String disbVchrContactEmailId)

Sets the disbVchrContactEmailId attribute.

Parameters:

disbVchrContactEmailId - The disbVchrContactEmailId to set.

getDisbursementVoucherDueDate

public Date getDisbursementVoucherDueDate()

Gets the disbursementVoucherDueDate attribute.

Returns:

Returns the disbursementVoucherDueDate

setDisbursementVoucherDueDate

public void setDisbursementVoucherDueDate(Date disbursementVoucherDueDate)

Sets the disbursementVoucherDueDate attribute.

Parameters:

disbursementVoucherDueDate - The disbursementVoucherDueDate to set.

isDisbVchrAttachmentCode

public boolean isDisbVchrAttachmentCode()

Gets the disbVchrAttachmentCode attribute.

Returns:

Returns the disbVchrAttachmentCode

setDisbVchrAttachmentCode

public void setDisbVchrAttachmentCode(boolean disbVchrAttachmentCode)

Sets the disbVchrAttachmentCode attribute.

Parameters:

disbVchrAttachmentCode - The disbVchrAttachmentCode to set.

isDisbVchrSpecialHandlingCode

public boolean isDisbVchrSpecialHandlingCode()

Gets the disbVchrSpecialHandlingCode attribute.

Returns:

Returns the disbVchrSpecialHandlingCode

setDisbVchrSpecialHandlingCode

public void setDisbVchrSpecialHandlingCode(boolean disbVchrSpecialHandlingCode)

Sets the disbVchrSpecialHandlingCode attribute.

Parameters:

disbVchrSpecialHandlingCode - The disbVchrSpecialHandlingCode to set.

getDisbVchrCheckTotalAmount

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

Gets the disbVchrCheckTotalAmount attribute.

Returns:

Returns the disbVchrCheckTotalAmount

setDisbVchrCheckTotalAmount

public void setDisbVchrCheckTotalAmount(org.kuali.rice.kns.util.KualiDecimal disbVchrCheckTotalAmount)

Sets the disbVchrCheckTotalAmount attribute.

Parameters:

disbVchrCheckTotalAmount - The disbVchrCheckTotalAmount to set.

isDisbVchrForeignCurrencyInd

public boolean isDisbVchrForeignCurrencyInd()

Gets the disbVchrForeignCurrencyInd attribute.

Returns:

Returns the disbVchrForeignCurrencyInd

setDisbVchrForeignCurrencyInd

public void setDisbVchrForeignCurrencyInd(boolean disbVchrForeignCurrencyInd)

Sets the disbVchrForeignCurrencyInd attribute.

Parameters:

disbVchrForeignCurrencyInd - The disbVchrForeignCurrencyInd to set.

getDisbursementVoucherDocumentationLocationCode

public String getDisbursementVoucherDocumentationLocationCode()

Gets the disbursementVoucherDocumentationLocationCode attribute.

Returns:

Returns the disbursementVoucherDocumentationLocationCode

setDisbursementVoucherDocumentationLocationCode

public void setDisbursementVoucherDocumentationLocationCode(String disbursementVoucherDocumentationLocationCode)

Sets the disbursementVoucherDocumentationLocationCode attribute.

Parameters:

disbursementVoucherDocumentationLocationCode - The disbursementVoucherDocumentationLocationCode to set.

getDisbVchrCheckStubText

public String getDisbVchrCheckStubText()

Gets the disbVchrCheckStubText attribute.

Returns:

Returns the disbVchrCheckStubText

setDisbVchrCheckStubText

public void setDisbVchrCheckStubText(String disbVchrCheckStubText)

Sets the disbVchrCheckStubText attribute.

Parameters:

disbVchrCheckStubText - The disbVchrCheckStubText to set.

getDvCheckStubOverflowCode

public boolean getDvCheckStubOverflowCode()

Gets the dvCheckStubOverflowCode attribute.

Returns:

Returns the dvCheckStubOverflowCode

setDvCheckStubOverflowCode

public void setDvCheckStubOverflowCode(boolean dvCheckStubOverflowCode)

Sets the dvCheckStubOverflowCode attribute.

Parameters:

dvCheckStubOverflowCode - The dvCheckStubOverflowCode to set.

getCampusCode

public String getCampusCode()

Gets the campusCode attribute.

Returns:

Returns the campusCode

setCampusCode

public void setCampusCode(String campusCode)

Sets the campusCode attribute.

Parameters:

campusCode - The campusCode to set.

getDisbVchrPayeeTaxControlCode

public String getDisbVchrPayeeTaxControlCode()

Gets the disbVchrPayeeTaxControlCode attribute.

Returns:

Returns the disbVchrPayeeTaxControlCode

setDisbVchrPayeeTaxControlCode

public void setDisbVchrPayeeTaxControlCode(String disbVchrPayeeTaxControlCode)

Sets the disbVchrPayeeTaxControlCode attribute.

Parameters:

disbVchrPayeeTaxControlCode - The disbVchrPayeeTaxControlCode to set.

isDisbVchrPayeeChangedInd

public boolean isDisbVchrPayeeChangedInd()

Gets the disbVchrPayeeChangedInd attribute.

Returns:

Returns the disbVchrPayeeChangedInd

setDisbVchrPayeeChangedInd

public void setDisbVchrPayeeChangedInd(boolean disbVchrPayeeChangedInd)

Sets the disbVchrPayeeChangedInd attribute.

Parameters:

disbVchrPayeeChangedInd - The disbVchrPayeeChangedInd to set.

getDisbursementVoucherCheckNbr

public String getDisbursementVoucherCheckNbr()

Gets the disbursementVoucherCheckNbr attribute.

Returns:

Returns the disbursementVoucherCheckNbr

setDisbursementVoucherCheckNbr

public void setDisbursementVoucherCheckNbr(String disbursementVoucherCheckNbr)

Sets the disbursementVoucherCheckNbr attribute.

Parameters:

disbursementVoucherCheckNbr - The disbursementVoucherCheckNbr to set.

getDisbursementVoucherCheckDate

public Timestamp getDisbursementVoucherCheckDate()

Gets the disbursementVoucherCheckDate attribute.

Returns:

Returns the disbursementVoucherCheckDate

setDisbursementVoucherCheckDate

public void setDisbursementVoucherCheckDate(Timestamp disbursementVoucherCheckDate)

Sets the disbursementVoucherCheckDate attribute.

Parameters:

disbursementVoucherCheckDate - The disbursementVoucherCheckDate to set.

getDisbVchrPayeeW9CompleteCode

public boolean getDisbVchrPayeeW9CompleteCode()

Gets the disbVchrPayeeW9CompleteCode attribute.

Returns:

Returns the disbVchrPayeeW9CompleteCode

setDisbVchrPayeeW9CompleteCode

public void setDisbVchrPayeeW9CompleteCode(boolean disbVchrPayeeW9CompleteCode)

Sets the disbVchrPayeeW9CompleteCode attribute.

Parameters:

disbVchrPayeeW9CompleteCode - The disbVchrPayeeW9CompleteCode to set.

getDisbVchrPaymentMethodCode

public String getDisbVchrPaymentMethodCode()

Gets the disbVchrPaymentMethodCode attribute.

Returns:

Returns the disbVchrPaymentMethodCode

setDisbVchrPaymentMethodCode

public void setDisbVchrPaymentMethodCode(String disbVchrPaymentMethodCode)

Sets the disbVchrPaymentMethodCode attribute.

Parameters:

disbVchrPaymentMethodCode - The disbVchrPaymentMethodCode to set.

getFinancialDocument

public org.kuali.rice.kns.bo.DocumentHeader getFinancialDocument()

Gets the financialDocument attribute.

Returns:

Returns the financialDocument

setFinancialDocument

public void setFinancialDocument(org.kuali.rice.kns.bo.DocumentHeader financialDocument)

Deprecated.

Sets the financialDocument attribute.

Parameters:

financialDocument - The financialDocument to set.

getDisbVchrDocumentationLoc

public DisbursementVoucherDocumentationLocation getDisbVchrDocumentationLoc()

Gets the disbVchrDocumentationLoc attribute.

Returns:

Returns the disbVchrDocumentationLoc

setDisbVchrDocumentationLoc

public void setDisbVchrDocumentationLoc(DisbursementVoucherDocumentationLocation disbVchrDocumentationLoc)

Deprecated.

Sets the disbVchrDocumentationLoc attribute.

Parameters:

disbVchrDocumentationLoc - The disbVchrDocumentationLoc to set.

getDvNonEmployeeTravel

public DisbursementVoucherNonEmployeeTravel getDvNonEmployeeTravel()

Returns:

Returns the dvNonEmployeeTravel.

setDvNonEmployeeTravel

public void setDvNonEmployeeTravel(DisbursementVoucherNonEmployeeTravel dvNonEmployeeTravel)

Parameters:

dvNonEmployeeTravel - The dvNonEmployeeTravel to set.

getDvNonResidentAlienTax

public DisbursementVoucherNonResidentAlienTax getDvNonResidentAlienTax()

Returns:

Returns the dvNonResidentAlienTax.

setDvNonResidentAlienTax

public void setDvNonResidentAlienTax(DisbursementVoucherNonResidentAlienTax dvNonResidentAlienTax)

Parameters:

dvNonResidentAlienTax - The dvNonResidentAlienTax to set.

getDvPayeeDetail

public DisbursementVoucherPayeeDetail getDvPayeeDetail()

Returns:

Returns the dvPayeeDetail.

setDvPayeeDetail

public void setDvPayeeDetail(DisbursementVoucherPayeeDetail dvPayeeDetail)

Parameters:

dvPayeeDetail - The dvPayeeDetail to set.

getDvPreConferenceDetail

public DisbursementVoucherPreConferenceDetail getDvPreConferenceDetail()

Returns:

Returns the dvPreConferenceDetail.

setDvPreConferenceDetail

public void setDvPreConferenceDetail(DisbursementVoucherPreConferenceDetail dvPreConferenceDetail)

Parameters:

dvPreConferenceDetail - The dvPreConferenceDetail to set.

getDvWireTransfer

public DisbursementVoucherWireTransfer getDvWireTransfer()

Returns:

Returns the dvWireTransfer.

setDvWireTransfer

public void setDvWireTransfer(DisbursementVoucherWireTransfer dvWireTransfer)

Parameters:

dvWireTransfer - The dvWireTransfer to set.

isExceptionIndicator

public boolean isExceptionIndicator()

Returns:

Returns the exceptionIndicator.

setExceptionIndicator

public void setExceptionIndicator(boolean exceptionIndicator)

Parameters:

exceptionIndicator - The exceptionIndicator to set.

getCancelDate

public Date getCancelDate()

Gets the cancelDate attribute.

Returns:

Returns the cancelDate.

setCancelDate

public void setCancelDate(Date cancelDate)

Sets the cancelDate attribute value.

Parameters:

cancelDate - The cancelDate to set.

getExtractDate

public Date getExtractDate()

Gets the extractDate attribute.

Returns:

Returns the extractDate.

setExtractDate

public void setExtractDate(Date extractDate)

Sets the extractDate attribute value.

Parameters:

extractDate - The extractDate to set.

getPaidDate

public Date getPaidDate()

Gets the paidDate attribute.

Returns:

Returns the paidDate.

setPaidDate

public void setPaidDate(Date paidDate)

Sets the paidDate attribute value.

Parameters:

paidDate - The paidDate to set.

getDisbursementVoucherPdpStatus

public String getDisbursementVoucherPdpStatus()

Based on which pdp dates are present (extract, paid, canceled), determines a String for the status

Returns:

a String representation of the status

setDisbursementVoucherPdpStatus

public void setDisbursementVoucherPdpStatus(String status)

Pretends to set the PDP status for this document

Parameters:

status - the status to pretend to set

addDvPrePaidRegistrantLine

public void addDvPrePaidRegistrantLine(DisbursementVoucherPreConferenceRegistrant line)

Adds a dv pre-paid registrant line

Parameters:

line -

getDisbVchrPaymentMethodName

public String getDisbVchrPaymentMethodName()

Returns the name associated with the payment method code

Returns:

String

setDisbVchrPaymentMethodName

public void setDisbVchrPaymentMethodName(String method)

Deprecated. This method should not be used. There is no protected attribute to store this value. The associated getter retrieves the value remotely.

This method...

Parameters:

method -

getDisbursementVoucherDocumentationLocationName

public String getDisbursementVoucherDocumentationLocationName()

Returns the name associated with the documentation location name

Returns:

String

setDisbursementVoucherDocumentationLocationName

public void setDisbursementVoucherDocumentationLocationName(String name)

Deprecated. This method should not be used. There is no protected attribute to store this value. The associated getter retrieves the value remotely.

This method...

Parameters:

name -

getDisbVchrBankCode

public String getDisbVchrBankCode()

Gets the disbVchrBankCode attribute.

Returns:

Returns the disbVchrBankCode.

setDisbVchrBankCode

public void setDisbVchrBankCode(String disbVchrBankCode)

Sets the disbVchrBankCode attribute value.

Parameters:

disbVchrBankCode - The disbVchrBankCode to set.

getBank

public Bank getBank()

Gets the bank attribute.

Returns:

Returns the bank.

setBank

public void setBank(Bank bank)

Sets the bank attribute value.

Parameters:

bank - The bank to set.

templateVendor

public void templateVendor(VendorDetail vendor,
                           VendorAddress vendorAddress)

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

Parameters:

vendor -

templateEmployee

public void templateEmployee(org.kuali.rice.kim.bo.Person employee)

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

Parameters:

employee -

getNonDefaultAddress

protected org.kuali.rice.kim.bo.entity.KimEntityAddress getNonDefaultAddress(org.kuali.rice.kim.bo.Person employee)

Finds the address for the given employee, matching the type in the KFS-FP / Disbursement Voucher/ DEFAULT_EMPLOYEE_ADDRESS_TYPE parameter, to use as the address for the employee

Parameters:

employee - the employee to find a non-default address for

Returns:

the non-default address, or null if not found

getPersonEntityEntityType

protected org.kuali.rice.kim.bo.entity.KimEntityEntityType getPersonEntityEntityType(org.kuali.rice.kim.bo.entity.dto.KimEntityInfo entityInfo)

Someday this method will be in Rice. But...'til it is...lazy loop through the entity entity types in the given KimEntityInfo and return the one who has the type of "PERSON"

Parameters:

entityInfo - the entity info to loop through entity entity types of

Returns:

a found entity entity type or null if a PERSON entity entity type is not associated with the given KimEntityInfo record

findAddressByType

protected org.kuali.rice.kim.bo.entity.KimEntityAddress findAddressByType(List<? extends org.kuali.rice.kim.bo.entity.KimEntityAddress> addresses,
                                                                          String addressType)

Given a List of KimEntityAddress and an address type, finds the address in the List with the given type (or null if no matching KimEntityAddress is found)

Parameters:

addresses - the List of KimEntityAddress records to search

addressType - the address type of the address to return

Returns:

the found KimEntityAddress, or null if not found

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.kns.document.Document

Overrides:

prepareForSave in class FinancialSystemTransactionalDocumentBase

See Also:

Document.prepareForSave()

shouldClearSpecialHandling

protected boolean shouldClearSpecialHandling()

Determines if the special handling fields should be cleared, based on whether the special handling has been turned off and whether the current node is CAMPUS

Returns:

true if special handling should be cleared, false otherwise

clearSpecialHandling

protected void clearSpecialHandling()

Clears all set special handling fields

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.kns.document.Document

Overrides:

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

See Also:

DocumentBase.populateDocumentForRouting()

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.

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()

initiateDocument

public void initiateDocument()

generic, shared logic used to initiate a dv document

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.kns.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class AccountingDocumentBase

See Also:

PersistableBusinessObjectBase.buildListOfDeletionAwareLists()

getTotalDollarAmount

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

Returns check total.

Specified by:

getTotalDollarAmount in interface AmountTotaling

Overrides:

getTotalDollarAmount in class AccountingDocumentBase

Returns:

KualiDecimal

See Also:

AccountingDocumentBase.getTotalDollarAmount()

isDebit

public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)

Returns true if accounting line debit

Specified by:

isDebit in interface GeneralLedgerPendingEntrySource

Specified by:

isDebit in class AccountingDocumentBase

Parameters:

financialDocument - submitted accounting document

accountingLine - accounting line in accounting document

Returns:

true if document is debit

See Also:

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

customizeExplicitGeneralLedgerPendingEntry

public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail accountingLine,
                                                       GeneralLedgerPendingEntry explicitEntry)

Override to change the doc type based on payment method. This is needed to pick up different offset definitions.

Overrides:

customizeExplicitGeneralLedgerPendingEntry in class AccountingDocumentBase

Parameters:

financialDocument - submitted accounting document

accountingLine - accounting line in submitted accounting document

explicitEntry - explicit GLPE

See Also:

org.kuali.module.financial.rules.FinancialDocumentRuleBase#customizeExplicitGeneralLedgerPendingEntry(org.kuali.rice.kns.document.FinancialDocument, org.kuali.rice.kns.bo.AccountingLine, org.kuali.module.gl.bo.GeneralLedgerPendingEntry)

generateDocumentGeneralLedgerPendingEntries

public boolean generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Return true if GLPE's are generated successfully (i.e. there are either 0 GLPE's or 1 GLPE in disbursement voucher document)

Specified by:

generateDocumentGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Overrides:

generateDocumentGeneralLedgerPendingEntries in class AccountingDocumentBase

Parameters:

financialDocument - submitted financial document

sequenceHelper - helper class to keep track of GLPE sequence

Returns:

true if GLPE's are generated successfully

See Also:

org.kuali.rice.kns.rule.GenerateGeneralLedgerDocumentPendingEntriesRule#processGenerateDocumentGeneralLedgerPendingEntries(org.kuali.rice.kns.document.FinancialDocument,org.kuali.kfs.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

processWireChargeDebitEntries

protected GeneralLedgerPendingEntry processWireChargeDebitEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                                                                  WireCharge wireCharge)

Builds an explicit and offset for the wire charge debit. The account associated with the first accounting is used for the debit. The explicit and offset entries for the first accounting line and copied and customized for the wire charge.

Parameters:

dvDocument - submitted disbursement voucher document

sequenceHelper - helper class to keep track of GLPE sequence

wireCharge - wireCharge object from current fiscal year

Returns:

GeneralLedgerPendingEntry generated wire charge debit

processWireChargeCreditEntries

protected void processWireChargeCreditEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                                              WireCharge wireCharge,
                                              GeneralLedgerPendingEntry chargeEntry)

Builds an explicit and offset for the wire charge credit. The account and income object code found in the wire charge table is used for the entry.

Parameters:

dvDocument - submitted disbursement voucher document

sequenceHelper - helper class to keep track of GLPE sequence

chargeEntry - GLPE charge

wireCharge - wireCharge object from current fiscal year

generateDocumentBankOffsetEntries

public boolean generateDocumentBankOffsetEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

If bank specification is enabled generates bank offsetting entries for the document amount

Parameters:

sequenceHelper - helper class to keep track of GLPE sequence

paymentMethodCode - the payment method of this DV

retrieveWireCharge

protected WireCharge retrieveWireCharge()

Retrieves the wire transfer information for the current fiscal year.

Returns:

WireCharge

isPayeeAssigned

public boolean isPayeeAssigned()

Gets the payeeAssigned attribute. This method returns a flag that is used to indicate if the payee type and value has been set on the DV. This value is used to determine the correct page that should be loaded by the DV flow.

Returns:

Returns the payeeAssigned.

setPayeeAssigned

public void setPayeeAssigned(boolean payeeAssigned)

Sets the payeeAssigned attribute value.

Parameters:

payeeAssigned - The payeeAssigned to set.

isEditW9W8BENbox

public boolean isEditW9W8BENbox()

Gets the editW9W8BENbox attribute. This method returns a flag that is used to indicate if the W9/W8BEN check box can be edited by the initiator on the DV.

Returns:

Returns the editW9W8BENbox.

setEditW9W8BENbox

public void setEditW9W8BENbox(boolean editW9W8BENbox)

Sets the editW9W8BENbox attribute value.

Parameters:

editW9W8BENbox - The editW9W8BENbox to set.

getDisbVchrPdpBankCode

public String getDisbVchrPdpBankCode()

Gets the disbVchrPdpBankCode attribute.

Returns:

Returns the disbVchrPdpBankCode.

setDisbVchrPdpBankCode

public void setDisbVchrPdpBankCode(String disbVchrPdpBankCode)

Sets the disbVchrPdpBankCode attribute value.

Parameters:

disbVchrPdpBankCode - The disbVchrPDPBankCode to set.

getDocumentTitle

public String getDocumentTitle()

Specified by:

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

Overrides:

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

See Also:

DocumentBase.getDocumentTitle()

buildDocumentTitle

protected String buildDocumentTitle(String title)

build document title based on the properties of current document

Parameters:

the - default document title

Returns:

the combine information of the given title and additional payment indicators

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Provides answers to the following splits: PayeeIsPurchaseOrderVendor RequiresTaxReview RequiresTravelReview

Specified by:

answerSplitNodeQuestion in interface FinancialSystemTransactionalDocument

Overrides:

answerSplitNodeQuestion in class FinancialSystemTransactionalDocumentBase

Throws:

UnsupportedOperationException

See Also:

FinancialSystemTransactionalDocumentBase.answerSplitNodeQuestion(java.lang.String)

isPayeePurchaseOrderVendor

protected boolean isPayeePurchaseOrderVendor()

Returns:

true if the payee is a purchase order vendor and therefore should receive vendor review, false otherwise

isTaxReviewRequired

protected boolean isTaxReviewRequired()

Tax review is required under the following circumstances: the payee was an employee the payee was a non-resident alien vendor the tax control code = "B" or "H" the payment reason code was "D" the payment reason code was "M" and the campus was listed in the CAMPUSES_TAXED_FOR_MOVING_REIMBURSEMENTS_PARAMETER_NAME parameter

Returns:

true if any of the above conditions exist and this document should receive tax review, false otherwise

isPayeePurchaseOrderVendorHasWithholding

protected boolean isPayeePurchaseOrderVendorHasWithholding()

Returns:

true if the payee is a vendor and has withholding dates therefore should receive tax review, false otherwise

taxedCampusForMovingReimbursements

protected boolean taxedCampusForMovingReimbursements()

Determines if the campus this DV is related to is taxed (and should get tax review routing) for moving reimbursements

Returns:

true if the campus is taxed for moving reimbursements, false otherwise

isTravelReviewRequired

public boolean isTravelReviewRequired()

Travel review is required under the following circumstances: payment reason code is "P" or "N"

Returns:

getPersonService

protected org.kuali.rice.kim.service.PersonService<org.kuali.rice.kim.bo.Person> getPersonService()

getParameterService

protected org.kuali.rice.kns.service.ParameterService getParameterService()

getVendorService

protected VendorService getVendorService()

getBusinessObjectService

protected org.kuali.rice.kns.service.BusinessObjectService getBusinessObjectService()

getDvPymentReasonService

public DisbursementVoucherPaymentReasonService getDvPymentReasonService()

Gets the dvPymentReasonService attribute.

Returns:

Returns the dvPymentReasonService.

getIdentityManagementService

public static org.kuali.rice.kim.service.IdentityManagementService getIdentityManagementService()

Gets the identityManagementService attribute.

Returns:

Returns the identityManagementService.

setIdentityManagementService

public static void setIdentityManagementService(org.kuali.rice.kim.service.IdentityManagementService identityManagementService)

Sets the identityManagementService attribute value.

Parameters:

identityManagementService - The identityManagementService to set.

isDisbExcptAttachedIndicator

public boolean isDisbExcptAttachedIndicator()

Returns:

Returns the disbExcptAttachedIndicator.

setDisbExcptAttachedIndicator

public void setDisbExcptAttachedIndicator(boolean disbExcptAttachedIndicator)

Parameters:

disbExcptAttachedIndicator - The disbExcptAttachedIndicator to set.