org.kuali.ole.fp.document.web.struts

Class DisbursementVoucherForm

java.lang.Object

org.apache.struts.action.ActionForm

org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

org.kuali.ole.fp.document.web.struts.DisbursementVoucherForm

All Implemented Interfaces:

Serializable, org.kuali.rice.kns.web.struts.form.pojo.PojoForm

Direct Known Subclasses:

OleDisbursementVoucherForm

public class DisbursementVoucherForm
extends KualiAccountingDocumentFormBase

This class is the action form for the Disbursement Voucher.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kns.web.struts.form.KualiForm.TabState

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canExport
protected boolean	hasMultipleAddresses
protected static org.apache.log4j.Logger	LOG
protected DisbursementVoucherNonEmployeeExpense	newNonEmployeeExpenseLine
protected DisbursementVoucherPreConferenceRegistrant	newPreConferenceRegistrantLine
protected DisbursementVoucherNonEmployeeExpense	newPrePaidNonEmployeeExpenseLine
protected String	oldPayeeType
protected String	payeeIdNumber
protected static long	serialVersionUID
protected String	tempPayeeIdNumber
protected String	tempVendorAddressGeneratedIdentifier
protected String	tempVendorDetailAssignedIdentifier
protected String	tempVendorHeaderGeneratedIdentifier
protected String	vendorAddressGeneratedIdentifier
protected String	vendorDetailAssignedIdentifier
protected String	vendorHeaderGeneratedIdentifier
protected String	wireChargeMessage

Fields inherited from class org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

editableAccounts, forcedLookupOptionalFields, hideDetails, newSourceLine, newTargetLine, sourceFile, targetFile

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

forcedReadOnlyFields

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

adHocActionRequestCodes, attachmentFile, documentActions, editingMode, suppressAllButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

extraButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

requiredNonEditableProperties

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
DisbursementVoucherForm() Constructs a DisbursementVoucherForm.java.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getCanPrintCoverSheet() determines if the DV document is in a state that allows printing of the cover sheet
protected String	getDefaultDocumentTypeName()
String	getDisbursementInfoUrl() RQ_AP_0760 : Ability to view disbursement information on the Disbursement Voucher Document.
DisbursementVoucherDocument	getDisbursementVoucherDocument()
protected List<String>	getExcludedmethodToCall() get the names of the methods to call that can be excluded from the "be used" check.
boolean	getHasMultipleAddresses() Gets the hasMultipleAddresses attribute.
DisbursementVoucherNonEmployeeExpense	getNewNonEmployeeExpenseLine()
DisbursementVoucherPreConferenceRegistrant	getNewPreConferenceRegistrantLine()
DisbursementVoucherNonEmployeeExpense	getNewPrePaidNonEmployeeExpenseLine()
String	getOldPayeeType() Gets the oldPayeeType attribute.
String	getPayeeIdNumber() Gets the payeeIdNumber attribute.
String	getTempPayeeIdNumber() Gets the payeeIdNumber attribute.
String	getTempVendorAddressGeneratedIdentifier() Gets the tempVendorAddressGeneratedIdentifier attribute.
String	getTempVendorDetailAssignedIdentifier() Gets the tempVendorDetailAssignedIdentifier attribute.
String	getTempVendorHeaderGeneratedIdentifier() Gets the tempVendorHeaderGeneratedIdentifier attribute.
List<TravelPerDiem>	getTravelPerDiemCategoryCodes()
String	getVendorAddressGeneratedIdentifier() Gets the vendorAddressGeneratedIdentifier attribute.
String	getVendorDetailAssignedIdentifier() Gets the vendorDetailAssignedIdentifier attribute.
String	getVendorHeaderGeneratedIdentifier() Gets the vendorHeaderGeneratedIdentifier attribute.
String	getWireChargeMessage()
boolean	hasMultipleAddresses() Gets the hasMultipleAddresses attribute.
boolean	isCanExport() Gets the canExport attribute.
boolean	isEmployee() determine whether the selected payee is an employee
boolean	isVendor() determine whether the selected payee is a vendor
void	populate(javax.servlet.http.HttpServletRequest request) Overrides the parent to call super.populate and then to call the accounting lines populate method that is specific to loading the two select lists on the page.
void	setCanExport(boolean canExport) Sets the canExport attribute value.
void	setHasMultipleAddresses(boolean hasMultipleAddresses) Sets the hasMultipleAddresses attribute value.
void	setNewNonEmployeeExpenseLine(DisbursementVoucherNonEmployeeExpense newNonEmployeeExpenseLine)
void	setNewPreConferenceRegistrantLine(DisbursementVoucherPreConferenceRegistrant newPreConferenceRegistrantLine)
void	setNewPrePaidNonEmployeeExpenseLine(DisbursementVoucherNonEmployeeExpense newPrePaidNonEmployeeExpenseLine)
void	setOldPayeeType(String oldPayeeType) Sets the oldPayeeType attribute value.
void	setPayeeIdNumber(String payeeIdNumber) Sets the payeeIdNumber attribute value.
void	setTempPayeeIdNumber(String payeeIdNumber) Sets the payeeIdNumber attribute value.
void	setTempVendorAddressGeneratedIdentifier(String tempVendorAddressGeneratedIdentifier) Sets the tempVendorAddressGeneratedIdentifier attribute value.
void	setTempVendorDetailAssignedIdentifier(String tempVendorDetailAssignedIdentifier) Sets the tempVendorDetailAssignedIdentifier attribute value.
void	setTempVendorHeaderGeneratedIdentifier(String tempVendorHeaderGeneratedIdentifier) Sets the tempVendorHeaderGeneratedIdentifier attribute value.
void	setVendorAddressGeneratedIdentifier(String vendorAddressGeneratedIdentifier) Sets the vendorAddressGeneratedIdentifier attribute value.
void	setVendorDetailAssignedIdentifier(String vendorDetailAssignedIdentifier) Sets the vendorDetailAssignedIdentifier attribute value.
void	setVendorHeaderGeneratedIdentifier(String vendorHeaderGeneratedIdentifier) Sets the vendorHeaderGeneratedIdentifier attribute value.
void	setWireChargeMessage(String wireChargeMessage)
boolean	shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, javax.servlet.http.HttpServletRequest request) This overridden method ...

Methods inherited from class org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

createNewSourceAccountingLine, createNewTargetAccountingLine, customInitMaxUploadSizes, getAccountingLineImportInstructionsUrl, getCurrencyFormattedSourceTotal, getCurrencyFormattedTargetTotal, getEditableAccounts, getFinancialDocument, getForcedLookupOptionalFields, getHideDetails, getNewSourceLine, getNewTargetLine, getSourceFile, getTargetFile, harvestAccountingLines, isHideDetails, populateAccountingLine, populateAccountingLines, populateAccountingLinesForResponse, populateSourceAccountingLine, populateTargetAccountingLine, repopulateOverrides, setEditableAccounts, setForcedLookupOptionalFields, setHideDetails, setNewSourceLine, setNewTargetLine, setSourceFile, setTargetFile

Methods inherited from class org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

extendDocInfoToThreeColumns, generateErrorCorrectionButton, getExtraButtons, populateHeaderFields

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

discoverDocumentTypeName, formatReversalDate, getForcedReadOnlyFields, getTransactionalDocument, instantiateTransactionalDocumentByDocumentTypeName, populateEmptyMultiSelect, populateFalseCheckboxes, populationSpecialEmptyFields, setForcedReadOnlyFields

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

addRequiredNonEditableProperties, buildHtmlLink, getActionRequests, getActionRequestsRequiringApproval, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getSelectedActionRequests, getStandardHeaderFields, getSuperUserAnnotation, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isStateAllowsApproveOrDisapprove, isStateAllowsApproveSingleActionRequest, isStateInitiatedFinalCancelled, isStateProcessedOrDisapproved, isSuperUserActionAvaliable, isSuperUserApproveDocumentAuthorized, isSuperUserApproveSingleActionRequestAuthorized, isSuperUserAuthorized, isSuperUserDisapproveDocumentAuthorized, isSuppressAllButtons, isUserDocumentInitiator, reset, setActionRequests, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocument, setDocumentActions, setEditingMode, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, setSelectedActionRequests, setSuperUserAnnotation, setSuppressAllButtons, shouldPropertyBePopulatedInForm, validate

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populateBackLocation, populateFieldLevelHelpEnabled, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setMethodToCall, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates

Methods inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, processValidationFail, registerEditableProperty, registerIsNewForm, registerRequiredNonEditableProperty, registerStrutsActionMappingScope, setActionEditablePropertiesGuid, setFormatterType, setFormatterTypes, setPopulateEditablePropertiesGuid, setUnconvertedValues

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

payeeIdNumber

protected String payeeIdNumber

vendorHeaderGeneratedIdentifier

protected String vendorHeaderGeneratedIdentifier

vendorDetailAssignedIdentifier

protected String vendorDetailAssignedIdentifier

vendorAddressGeneratedIdentifier

protected String vendorAddressGeneratedIdentifier

tempPayeeIdNumber

protected String tempPayeeIdNumber

tempVendorHeaderGeneratedIdentifier

protected String tempVendorHeaderGeneratedIdentifier

tempVendorDetailAssignedIdentifier

protected String tempVendorDetailAssignedIdentifier

tempVendorAddressGeneratedIdentifier

protected String tempVendorAddressGeneratedIdentifier

oldPayeeType

protected String oldPayeeType

hasMultipleAddresses

protected boolean hasMultipleAddresses

newNonEmployeeExpenseLine

protected DisbursementVoucherNonEmployeeExpense newNonEmployeeExpenseLine

newPrePaidNonEmployeeExpenseLine

protected DisbursementVoucherNonEmployeeExpense newPrePaidNonEmployeeExpenseLine

newPreConferenceRegistrantLine

protected DisbursementVoucherPreConferenceRegistrant newPreConferenceRegistrantLine

wireChargeMessage

protected String wireChargeMessage

canExport

protected boolean canExport

Constructor Detail

DisbursementVoucherForm

public DisbursementVoucherForm()

Constructs a DisbursementVoucherForm.java.

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class KualiDocumentFormBase

getNewNonEmployeeExpenseLine

public DisbursementVoucherNonEmployeeExpense getNewNonEmployeeExpenseLine()

Returns:

Returns the newNonEmployeeExpenseLine.

setNewNonEmployeeExpenseLine

public void setNewNonEmployeeExpenseLine(DisbursementVoucherNonEmployeeExpense newNonEmployeeExpenseLine)

Parameters:

newNonEmployeeExpenseLine - The newNonEmployeeExpenseLine to set.

getNewPreConferenceRegistrantLine

public DisbursementVoucherPreConferenceRegistrant getNewPreConferenceRegistrantLine()

Returns:

Returns the newPreConferenceRegistrantLine.

setNewPreConferenceRegistrantLine

public void setNewPreConferenceRegistrantLine(DisbursementVoucherPreConferenceRegistrant newPreConferenceRegistrantLine)

Parameters:

newPreConferenceRegistrantLine - The newPreConferenceRegistrantLine to set.

getNewPrePaidNonEmployeeExpenseLine

public DisbursementVoucherNonEmployeeExpense getNewPrePaidNonEmployeeExpenseLine()

Returns:

Returns the newPrePaidNonEmployeeExpenseLine.

setNewPrePaidNonEmployeeExpenseLine

public void setNewPrePaidNonEmployeeExpenseLine(DisbursementVoucherNonEmployeeExpense newPrePaidNonEmployeeExpenseLine)

Parameters:

newPrePaidNonEmployeeExpenseLine - The newPrePaidNonEmployeeExpenseLine to set.

getWireChargeMessage

public String getWireChargeMessage()

Returns:

Returns the wireChargeMessage.

setWireChargeMessage

public void setWireChargeMessage(String wireChargeMessage)

Parameters:

wireChargeMessage - The wireChargeMessage to set.

getCanPrintCoverSheet

public boolean getCanPrintCoverSheet()

determines if the DV document is in a state that allows printing of the cover sheet

Returns:

true if the DV document is in a state that allows printing of the cover sheet; otherwise, return false

getTravelPerDiemCategoryCodes

public List<TravelPerDiem> getTravelPerDiemCategoryCodes()

Returns:

a list of available travel expense type codes for rendering per diem link page.

getPayeeIdNumber

public String getPayeeIdNumber()

Gets the payeeIdNumber attribute.

Returns:

Returns the payeeIdNumber.

setPayeeIdNumber

public void setPayeeIdNumber(String payeeIdNumber)

Sets the payeeIdNumber attribute value.

Parameters:

payeeIdNumber - The payeeIdNumber to set.

getTempPayeeIdNumber

public String getTempPayeeIdNumber()

Gets the payeeIdNumber attribute.

Returns:

Returns the payeeIdNumber.

setTempPayeeIdNumber

public void setTempPayeeIdNumber(String payeeIdNumber)

Sets the payeeIdNumber attribute value.

Parameters:

payeeIdNumber - The payeeIdNumber to set.

hasMultipleAddresses

public boolean hasMultipleAddresses()

Gets the hasMultipleAddresses attribute.

Returns:

Returns the hasMultipleAddresses.

getHasMultipleAddresses

public boolean getHasMultipleAddresses()

Gets the hasMultipleAddresses attribute.

Returns:

Returns the hasMultipleAddresses.

setHasMultipleAddresses

public void setHasMultipleAddresses(boolean hasMultipleAddresses)

Sets the hasMultipleAddresses attribute value.

Parameters:

hasMultipleAddresses - The hasMultipleAddresses to set.

getVendorHeaderGeneratedIdentifier

public String getVendorHeaderGeneratedIdentifier()

Gets the vendorHeaderGeneratedIdentifier attribute.

Returns:

Returns the vendorHeaderGeneratedIdentifier.

setVendorHeaderGeneratedIdentifier

public void setVendorHeaderGeneratedIdentifier(String vendorHeaderGeneratedIdentifier)

Sets the vendorHeaderGeneratedIdentifier attribute value.

Parameters:

vendorHeaderGeneratedIdentifier - The vendorHeaderGeneratedIdentifier to set.

getVendorDetailAssignedIdentifier

public String getVendorDetailAssignedIdentifier()

Gets the vendorDetailAssignedIdentifier attribute.

Returns:

Returns the vendorDetailAssignedIdentifier.

setVendorDetailAssignedIdentifier

public void setVendorDetailAssignedIdentifier(String vendorDetailAssignedIdentifier)

Sets the vendorDetailAssignedIdentifier attribute value.

Parameters:

vendorDetailAssignedIdentifier - The vendorDetailAssignedIdentifier to set.

getVendorAddressGeneratedIdentifier

public String getVendorAddressGeneratedIdentifier()

Gets the vendorAddressGeneratedIdentifier attribute.

Returns:

Returns the vendorAddressGeneratedIdentifier.

setVendorAddressGeneratedIdentifier

public void setVendorAddressGeneratedIdentifier(String vendorAddressGeneratedIdentifier)

Sets the vendorAddressGeneratedIdentifier attribute value.

Parameters:

vendorAddressGeneratedIdentifier - The vendorAddressGeneratedIdentifier to set.

getDisbursementVoucherDocument

public DisbursementVoucherDocument getDisbursementVoucherDocument()

populate

public void populate(javax.servlet.http.HttpServletRequest request)

Description copied from class: KualiAccountingDocumentFormBase

Overrides the parent to call super.populate and then to call the accounting lines populate method that is specific to loading the two select lists on the page.

Specified by:

populate in interface org.kuali.rice.kns.web.struts.form.pojo.PojoForm

Overrides:

populate in class KualiAccountingDocumentFormBase

See Also:

KualiTransactionalDocumentFormBase.populate(javax.servlet.http.HttpServletRequest)

getTempVendorHeaderGeneratedIdentifier

public String getTempVendorHeaderGeneratedIdentifier()

Gets the tempVendorHeaderGeneratedIdentifier attribute.

Returns:

Returns the tempVendorHeaderGeneratedIdentifier.

setTempVendorHeaderGeneratedIdentifier

public void setTempVendorHeaderGeneratedIdentifier(String tempVendorHeaderGeneratedIdentifier)

Sets the tempVendorHeaderGeneratedIdentifier attribute value.

Parameters:

tempVendorHeaderGeneratedIdentifier - The tempVendorHeaderGeneratedIdentifier to set.

getTempVendorDetailAssignedIdentifier

public String getTempVendorDetailAssignedIdentifier()

Gets the tempVendorDetailAssignedIdentifier attribute.

Returns:

Returns the tempVendorDetailAssignedIdentifier.

setTempVendorDetailAssignedIdentifier

public void setTempVendorDetailAssignedIdentifier(String tempVendorDetailAssignedIdentifier)

Sets the tempVendorDetailAssignedIdentifier attribute value.

Parameters:

tempVendorDetailAssignedIdentifier - The tempVendorDetailAssignedIdentifier to set.

getTempVendorAddressGeneratedIdentifier

public String getTempVendorAddressGeneratedIdentifier()

Gets the tempVendorAddressGeneratedIdentifier attribute.

Returns:

Returns the tempVendorAddressGeneratedIdentifier.

setTempVendorAddressGeneratedIdentifier

public void setTempVendorAddressGeneratedIdentifier(String tempVendorAddressGeneratedIdentifier)

Sets the tempVendorAddressGeneratedIdentifier attribute value.

Parameters:

tempVendorAddressGeneratedIdentifier - The tempVendorAddressGeneratedIdentifier to set.

getOldPayeeType

public String getOldPayeeType()

Gets the oldPayeeType attribute.

Returns:

Returns the oldPayeeType.

setOldPayeeType

public void setOldPayeeType(String oldPayeeType)

Sets the oldPayeeType attribute value.

Parameters:

oldPayeeType - The oldPayeeType to set.

isEmployee

public boolean isEmployee()

determine whether the selected payee is an employee

isVendor

public boolean isVendor()

determine whether the selected payee is a vendor

shouldMethodToCallParameterBeUsed

public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName,
                                        String methodToCallParameterValue,
                                        javax.servlet.http.HttpServletRequest request)

Description copied from class: KualiDocumentFormBase

This overridden method ...

Overrides:

shouldMethodToCallParameterBeUsed in class KualiAccountingDocumentFormBase

See Also:

KualiDocumentFormBase.shouldMethodToCallParameterBeUsed(java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest)

getExcludedmethodToCall

protected List<String> getExcludedmethodToCall()

Description copied from class: KualiAccountingDocumentFormBase

get the names of the methods to call that can be excluded from the "be used" check.

Overrides:

getExcludedmethodToCall in class KualiAccountingDocumentFormBase

Returns:

the names of the methods to call that can be excluded from the "be used" check

See Also:

KualiAccountingDocumentFormBase.getExcludedmethodToCall()

isCanExport

public boolean isCanExport()

Gets the canExport attribute.

Returns:

Returns the canExport.

setCanExport

public void setCanExport(boolean canExport)

Sets the canExport attribute value.

Parameters:

canExport - The canExport to set.

getDisbursementInfoUrl

public String getDisbursementInfoUrl()

RQ_AP_0760 : Ability to view disbursement information on the Disbursement Voucher Document. This method composes the url to be used when we want to look up the payment details from the disbursementInfo.tag.

Returns: