org.kuali.kfs.module.ld.document.web.struts
Class ExpenseTransferDocumentFormBase

java.lang.Object
  org.apache.struts.action.ActionForm
      org.kuali.rice.kns.web.struts.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.ld.document.web.struts.LaborDocumentFormBase
                                  org.kuali.kfs.module.ld.document.web.struts.ExpenseTransferDocumentFormBase

All Implemented Interfaces:

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

Direct Known Subclasses:

BenefitExpenseTransferForm, SalaryExpenseTransferForm

public abstract class ExpenseTransferDocumentFormBase
extends LaborDocumentFormBase
implements MultipleValueLookupBroker

Base Struts Action Form for all expense transfer documents.

See Also:

Serialized Form

Field Summary

protected String	lookedUpCollectionName
protected String	lookupResultsBOClassName
protected String	lookupResultsSequenceNumber
protected Integer	universityFiscalYear

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.pojo.PojoFormBase

requiredNonEditableProperties

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

multipartRequestHandler, servlet

Constructor Summary

ExpenseTransferDocumentFormBase()
Constructs a ExpenseTransferDocumentFormBase instance for the dependent object.

Method Summary

void	addRequiredNonEditableProperties()
Map	getForcedReadOnlySourceFields() Gets forced read only source fields
Map	getForcedReadOnlyTargetFields() Returns forced read only target fields (i.e read only fields plus payroll end date fiscal period code and payroll end date fiscal year)
String	getLookedUpCollectionName() Get looked up collection name.
String	getLookupResultsBOClassName() Get lookup results business object class name.
String	getLookupResultsSequenceNumber() Get lookup results sequence number.
Integer	getUniversityFiscalYear() Gets the universityFiscalYear attribute.
abstract void	populateSearchFields() Populate the search fields with the last search criteria
void	populateSourceAccountingLine(SourceAccountingLine sourceLine, String accountingLinePropertyName, Map parameterMap) Deal with the labor-specific override code to the given source accounting line
void	populateTargetAccountingLine(TargetAccountingLine targetLine, String accountingLinePropertyName, Map parameterMap) Deal with the labor-specific override code to the given target accounting line
protected void	repopulateOverrides(AccountingLine line, String accountingLinePropertyName, Map parameterMap) This repopulates the override values from the request
void	setLookedUpCollectionName(String lookedUpCollectionName) Set looked up collection name.
void	setLookupResultsBOClassName(String lookupResultsBOClassName) Set lookup results business object class name.
void	setLookupResultsSequenceNumber(String lookupResultsSequenceNumber) Set lookup results sequence number.
void	setUniversityFiscalYear(Integer universityFiscalYear) Sets the universityFiscalYear attribute value.

Methods inherited from class org.kuali.kfs.module.ld.document.web.struts.LaborDocumentFormBase

getLaborDocument

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

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

Methods inherited from class org.kuali.kfs.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

buildHtmlLink, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDefaultDocumentTypeName, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getErrorMapFromPreviousRequest, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getStandardHeaderFields, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isSuppressAllButtons, isUserDocumentInitiator, reset, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocument, setDocumentActions, setEditingMode, setErrorMapFromPreviousRequest, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, 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.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.ld.document.web.struts.MultipleValueLookupBroker

getRefreshCaller

Field Detail

lookupResultsSequenceNumber

protected String lookupResultsSequenceNumber

lookupResultsBOClassName

protected String lookupResultsBOClassName

lookedUpCollectionName

protected String lookedUpCollectionName

universityFiscalYear

protected Integer universityFiscalYear

Constructor Detail

ExpenseTransferDocumentFormBase

public ExpenseTransferDocumentFormBase()

Constructs a ExpenseTransferDocumentFormBase instance for the dependent object.

Method Detail

addRequiredNonEditableProperties

public void addRequiredNonEditableProperties()

Specified by:

addRequiredNonEditableProperties in interface org.kuali.rice.kns.web.struts.pojo.PojoForm

Overrides:

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

getLookupResultsSequenceNumber

public String getLookupResultsSequenceNumber()

Description copied from interface: MultipleValueLookupBroker

Get lookup results sequence number.

Specified by:

getLookupResultsSequenceNumber in interface MultipleValueLookupBroker

Returns:

String

See Also:

MultipleValueLookupBroker.getLookupResultsSequenceNumber()

setLookupResultsSequenceNumber

public void setLookupResultsSequenceNumber(String lookupResultsSequenceNumber)

Description copied from interface: MultipleValueLookupBroker

Set lookup results sequence number.

Specified by:

setLookupResultsSequenceNumber in interface MultipleValueLookupBroker

See Also:

MultipleValueLookupBroker.setLookupResultsSequenceNumber(java.lang.String)

getLookupResultsBOClassName

public String getLookupResultsBOClassName()

Description copied from interface: MultipleValueLookupBroker

Get lookup results business object class name.

Specified by:

getLookupResultsBOClassName in interface MultipleValueLookupBroker

Returns:

String

See Also:

MultipleValueLookupBroker.getLookupResultsBOClassName()

setLookupResultsBOClassName

public void setLookupResultsBOClassName(String lookupResultsBOClassName)

Description copied from interface: MultipleValueLookupBroker

Set lookup results business object class name.

Specified by:

setLookupResultsBOClassName in interface MultipleValueLookupBroker

See Also:

MultipleValueLookupBroker.setLookupResultsBOClassName(java.lang.String)

getLookedUpCollectionName

public String getLookedUpCollectionName()

Description copied from interface: MultipleValueLookupBroker

Get looked up collection name.

Specified by:

getLookedUpCollectionName in interface MultipleValueLookupBroker

Returns:

String

See Also:

MultipleValueLookupBroker.getLookedUpCollectionName()

setLookedUpCollectionName

public void setLookedUpCollectionName(String lookedUpCollectionName)

Description copied from interface: MultipleValueLookupBroker

Set looked up collection name.

Specified by:

setLookedUpCollectionName in interface MultipleValueLookupBroker

See Also:

MultipleValueLookupBroker.setLookedUpCollectionName(java.lang.String)

getUniversityFiscalYear

public Integer getUniversityFiscalYear()

Gets the universityFiscalYear attribute.

Returns:

Returns the universityFiscalYear.

setUniversityFiscalYear

public void setUniversityFiscalYear(Integer universityFiscalYear)

Sets the universityFiscalYear attribute value.

Parameters:

universityFiscalYear - The universityFiscalYear to set.

populateSearchFields

public abstract void populateSearchFields()

Populate the search fields with the last search criteria

getForcedReadOnlySourceFields

public Map getForcedReadOnlySourceFields()

Gets forced read only source fields

Returns:

Returns a Map of read only source fields

getForcedReadOnlyTargetFields

public Map getForcedReadOnlyTargetFields()

Returns forced read only target fields (i.e read only fields plus payroll end date fiscal period code and payroll end date fiscal year)

See Also:

KualiTransactionalDocumentFormBase.getForcedReadOnlyFields()

populateSourceAccountingLine

public void populateSourceAccountingLine(SourceAccountingLine sourceLine,
                                         String accountingLinePropertyName,
                                         Map parameterMap)

Deal with the labor-specific override code to the given source accounting line

Overrides:

populateSourceAccountingLine in class KualiAccountingDocumentFormBase

accountingLinePropertyName - the property path from the form to the accounting line

parameterMap - the map of parameters that were sent in with the request

See Also:

org.kuali.kfs.sys.web.struts.KualiAccountingDocumentFormBase#populateSourceAccountingLine(org.kuali.kfs.sys.businessobject.SourceAccountingLine)

populateTargetAccountingLine

public void populateTargetAccountingLine(TargetAccountingLine targetLine,
                                         String accountingLinePropertyName,
                                         Map parameterMap)

Deal with the labor-specific override code to the given target accounting line

Overrides:

populateTargetAccountingLine in class KualiAccountingDocumentFormBase

accountingLinePropertyName - the property path from the form to the accounting line

parameterMap - the map of parameters that were sent in with the request

See Also:

org.kuali.kfs.sys.web.struts.KualiAccountingDocumentFormBase#populateTargetAccountingLine(org.kuali.kfs.sys.businessobject.TargetAccountingLine)

repopulateOverrides

protected void repopulateOverrides(AccountingLine line,
                                   String accountingLinePropertyName,
                                   Map parameterMap)

Description copied from class: KualiAccountingDocumentFormBase

This repopulates the override values from the request

Overrides:

repopulateOverrides in class KualiAccountingDocumentFormBase

Parameters:

line - the line to repopulate override values for

accountingLinePropertyName - the property path from the form to the accounting line

parameterMap - the map of parameters that were sent in with the request

See Also:

org.kuali.kfs.sys.web.struts.KualiAccountingDocumentFormBase#repopulateOverrides(org.kuali.kfs.sys.businessobject.AccountingLine, java.lang.String, javax.servlet.http.HttpServletRequest)