org.kuali.kfs.module.tem.document.web.struts

Class TravelReimbursementForm

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.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

org.kuali.kfs.sys.web.struts.KualiAccountingDocumentFormBase

org.kuali.kfs.module.tem.document.web.struts.TravelFormBase

org.kuali.kfs.module.tem.document.web.struts.TravelReimbursementForm

All Implemented Interfaces:

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

public class TravelReimbursementForm
extends TravelFormBase
implements TravelReimbursementMvcWrapperBean

Travel Reimbursement Form

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 inherited from class org.kuali.kfs.module.tem.document.web.struts.TravelFormBase

accountDistributionFile, accountDistributionnewSourceLine, accountDistributionnextSourceLineNumber, accountDistributionsourceAccountingLines, agencyLinks, distribution, groupTravelerImportFile, lookedUpCollectionName, lookupResultsBOClassName, lookupResultsSequenceNumber, perDiemCreatable, shouldDisplayAgencyLinks, VENDOR_PAYMENT_BUTTON_IMAGE_NAME

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

editableAccounts, forcedLookupOptionalFields, hideDetails, LOG, 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
TravelReimbursementForm() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCertify()
protected Map<String,org.kuali.rice.kns.web.ui.ExtraButton>	createButtonsMap() Creates a MAP for all the buttons to appear on the Travel Authorization Form, and sets the attributes of these buttons.
protected SourceAccountingLine	createNewSourceAccountingLine(AccountingDocument financialDocument) Pull the object code for the new line from the distribution, not the trip type
boolean	getCanCertify()
protected String	getDefaultDocumentTypeName()
protected String	getDocumentIdentifierFieldName() Retrieve the name of the document identifier field for datadictionary queries
Date	getEndDate() Gets the endDate attribute.
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraButtons() Add extra buttons to the TEM forms
List<Serializable>	getHistory()
TravelAdvance	getNewTravelAdvanceLine()
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
org.kuali.rice.kim.api.identity.PersonService	getPersonService()
Date	getStartDate() Gets the startDate attribute.
protected TravelAuthorizationService	getTravelAuthorizationService()
String	getTravelDocumentIdentifier()
String	getTravelPaymentFormAction()
TravelReimbursementDocument	getTravelReimbursementDocument() Get Travel Reimbursement Document
protected TravelReimbursementService	getTravelReimbursementService()
protected TravelService	getTravelService()
boolean	isCanUnmask()
boolean	isDefaultOpenPaymentInfoTab()
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	setCanCertify(boolean canCertify)
void	setCanUnmask(boolean canUnmask)
void	setEndDate(Date endDate) Sets the endDate attribute value.
void	setHistory(List<Serializable> history)
void	setNewAdvanceLine(TravelAdvance newTravelAdvanceLine)
void	setStartDate(Date startDate) Sets the startDate attribute value.
void	setTravelDocumentIdentifier(String travelDocumentIdentifier) Sets the travel document identifier to populate from

Methods inherited from class org.kuali.kfs.module.tem.document.web.struts.TravelFormBase

addAccountDistributionsourceAccountingLine, addExtraButton, canCalculate, canReturn, createDVExtraButtonMap, createNewReimbursementButtonMap, createPaymentExtraButtonMap, getAccountDistributionFile, getAccountDistributionnewSourceLine, getAccountDistributionnextSourceLineNumber, getAccountDistributionsourceAccountingLines, getAgencyLinks, getDataDictionaryAttributeName, getDefaultPerDiemMileageExpenseType, getDisbursementInfoUrl, getDistribution, getDistributionRemainingAmount, getDistributionSubTotal, getEmpPrincipalId, getExpenseLabel, getExpenseTabLabel, getForeignCurrencyUrl, getFullDistributionRemainingAmount, getFullDistributionSubTotal, getGroupTravelerImportFile, getHasSelectedDistributionRemainingAmount, getIsTravelAuthorizationDoc, getLookedUpCollectionName, getLookupResultsBOClassName, getLookupResultsSequenceNumber, getModesOfTransportation, getNewAccountingDocumentRelationship, getNewActualExpenseLine, getNewActualExpenseLines, getNewGroupTravelerLine, getNewImportedExpenseLine, getNewImportedExpenseLines, getNewSourceLine, getObservable, getPerDiemLabel, getPerDiemPercentage, getRelatedDocumentNotes, getRelatedDocuments, getSelectedDistributionRemainingAmount, getSelectedDistributionSubTotal, getStatusCodeFieldName, getTempEmpPrincipalId, getTempTravelerId, getTravelDocument, getTravelerId, getUploadParserInstructionsUrl, getWireChargeMessage, isCalculated, isCanShowImportExpenseDetails, isDisplayAccountingLines, isDisplayNonEmployeeForm, isOpenPaymentInformationWindow, isPerDiemCreatable, isShouldDisplayAgencyLinks, isShowAllPerDiemCategories, isShowLodging, isShowMileage, isShowPerDiem, isShowPerDiemBreakdown, parsePerDiemCategories, populateHeaderFields, setAccountDistributionFile, setAccountDistributionnewSourceLine, setAccountDistributionnextSourceLineNumber, setAccountDistributionsourceAccountingLines, setAgencyLinks, setCalculated, setCanCalculate, setCanReturn, setCanShowImportExpenseDetails, setDisplayNonEmployeeForm, setDistribution, setEmpPrincipalId, setForeignCurrencyUrl, setGroupTravelerImportFile, setLookedUpCollectionName, setLookupResultsBOClassName, setLookupResultsSequenceNumber, setNewAccountingDocumentRelationship, setNewActualExpenseLine, setNewActualExpenseLines, setNewGroupTravelerLine, setNewImportedExpenseLine, setNewImportedExpenseLines, setOpenPaymentInformationWindow, setPerDiemCreatable, setPerDiemPercentage, setPerDiemPercentage, setRelatedDocumentNotes, setRelatedDocuments, setShouldDisplayAgencyLinks, setShowLodging, setShowMileage, setShowPerDiem, setShowPerDiemBreakdown, setTempEmpPrincipalId, setTempTravelerId, setTravelerId, setupNewAccountDistributionAccountingLine, setWireChargeMessage

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

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

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

extendDocInfoToThreeColumns, generateErrorCorrectionButton

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

Methods inherited from interface org.kuali.kfs.module.tem.document.web.bean.TravelReimbursementMvcWrapperBean

getNewActualExpenseLine, getNewActualExpenseLines, setNewActualExpenseLine, setNewActualExpenseLines

Methods inherited from interface org.kuali.kfs.module.tem.document.web.bean.TravelMvcWrapperBean

addAccountDistributionsourceAccountingLine, canReturn, getAccountDistributionnewSourceLine, getAccountDistributionnextSourceLineNumber, getAccountDistributionsourceAccountingLines, getDistribution, getDistributionRemainingAmount, getDistributionSubTotal, getEmpPrincipalId, getMethodToCall, getModesOfTransportation, getNewAccountingDocumentRelationship, getNewImportedExpenseLine, getNewImportedExpenseLines, getPerDiemPercentage, getRelatedDocumentNotes, getRelatedDocuments, getTempEmpPrincipalId, getTempTravelerId, getTravelDocument, getTravelerId, isCalculated, isShowAllPerDiemCategories, isShowLodging, isShowMileage, isShowPerDiem, setAccountDistributionnewSourceLine, setAccountDistributionnextSourceLineNumber, setAccountDistributionsourceAccountingLines, setCalculated, setCanReturn, setDistribution, setEmpPrincipalId, setNewAccountingDocumentRelationship, setNewImportedExpenseLine, setNewImportedExpenseLines, setPerDiemPercentage, setPerDiemPercentage, setRelatedDocumentNotes, setRelatedDocuments, setShowLodging, setShowMileage, setShowPerDiem, setTempEmpPrincipalId, setTempTravelerId, setTravelerId

Constructor Detail

TravelReimbursementForm

public TravelReimbursementForm()

Constructor

Method Detail

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 TravelFormBase

See Also:

org.kuali.rice.kns.web.struts.pojo.PojoForm#populate(javax.servlet.http.HttpServletRequest)

isDefaultOpenPaymentInfoTab

public boolean isDefaultOpenPaymentInfoTab()

Overrides:

isDefaultOpenPaymentInfoTab in class TravelFormBase

createButtonsMap

protected Map<String,org.kuali.rice.kns.web.ui.ExtraButton> createButtonsMap()

Creates a MAP for all the buttons to appear on the Travel Authorization Form, and sets the attributes of these buttons.

Returns:

the button map created.

getExtraButtons

public List<org.kuali.rice.kns.web.ui.ExtraButton> getExtraButtons()

Description copied from class: TravelFormBase

Add extra buttons to the TEM forms

Specified by:

getExtraButtons in interface TravelMvcWrapperBean

Overrides:

getExtraButtons in class TravelFormBase

See Also:

FinancialSystemTransactionalDocumentFormBase.getExtraButtons()

canCertify

public boolean canCertify()

Specified by:

canCertify in interface TravelReimbursementMvcWrapperBean

getCanCertify

public boolean getCanCertify()

Specified by:

getCanCertify in interface TravelReimbursementMvcWrapperBean

setCanCertify

public void setCanCertify(boolean canCertify)

Specified by:

setCanCertify in interface TravelReimbursementMvcWrapperBean

getTravelReimbursementDocument

public TravelReimbursementDocument getTravelReimbursementDocument()

Get Travel Reimbursement Document

Specified by:

getTravelReimbursementDocument in interface TravelReimbursementMvcWrapperBean

Returns:

TravelReimbursementForm

getDocumentIdentifierFieldName

protected String getDocumentIdentifierFieldName()

Retrieve the name of the document identifier field for datadictionary queries

Specified by:

getDocumentIdentifierFieldName in class TravelFormBase

Returns:

String with the field name of the document identifier

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

getHistory

public List<Serializable> getHistory()

Specified by:

getHistory in interface TravelReimbursementMvcWrapperBean

setHistory

public void setHistory(List<Serializable> history)

Specified by:

setHistory in interface TravelReimbursementMvcWrapperBean

getStartDate

public Date getStartDate()

Gets the startDate attribute.

Specified by:

getStartDate in interface TravelReimbursementMvcWrapperBean

Returns:

Returns the startDate.

setStartDate

public void setStartDate(Date startDate)

Sets the startDate attribute value.

Specified by:

setStartDate in interface TravelReimbursementMvcWrapperBean

Parameters:

startDate - The startDate to set.

getEndDate

public Date getEndDate()

Gets the endDate attribute.

Specified by:

getEndDate in interface TravelReimbursementMvcWrapperBean

Returns:

Returns the endDate.

setEndDate

public void setEndDate(Date endDate)

Sets the endDate attribute value.

Specified by:

setEndDate in interface TravelReimbursementMvcWrapperBean

Parameters:

endDate - The endDate to set.

createNewSourceAccountingLine

protected SourceAccountingLine createNewSourceAccountingLine(AccountingDocument financialDocument)

Pull the object code for the new line from the distribution, not the trip type

Overrides:

createNewSourceAccountingLine in class TravelFormBase

Parameters:

financialDocument - the financial document which needs a new accounting line

Returns:

a new accounting line for the form

getTravelService

protected TravelService getTravelService()

getTravelReimbursementService

protected TravelReimbursementService getTravelReimbursementService()

getPersonService

public org.kuali.rice.kim.api.identity.PersonService getPersonService()

getTravelAuthorizationService

protected TravelAuthorizationService getTravelAuthorizationService()

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Overrides:

getParameterService in class TravelFormBase

getNewTravelAdvanceLine

public TravelAdvance getNewTravelAdvanceLine()

setNewAdvanceLine

public void setNewAdvanceLine(TravelAdvance newTravelAdvanceLine)

isCanUnmask

public boolean isCanUnmask()

setCanUnmask

public void setCanUnmask(boolean canUnmask)

getTravelPaymentFormAction

public String getTravelPaymentFormAction()

Specified by:

getTravelPaymentFormAction in class TravelFormBase

Returns:

the name of the action which the current form should return to

See Also:

TravelFormBase.getTravelPaymentFormAction()

getTravelDocumentIdentifier

public String getTravelDocumentIdentifier()

Returns:

the travel document identifier if it has been set

setTravelDocumentIdentifier

public void setTravelDocumentIdentifier(String travelDocumentIdentifier)

Sets the travel document identifier to populate from

Parameters:

travelDocumentIdentifier - the travel document identifier to populate from