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

Class AuxiliaryVoucherForm

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

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

All Implemented Interfaces:

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

public class AuxiliaryVoucherForm
extends VoucherForm

Struts form so AuxiliaryVoucherDocument can be accessed and modified through UI.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AuxiliaryVoucherForm.OpenAuxiliaryVoucherPredicate

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 String	originalVoucherType
static String	REVERSAL_DATE_DEFAULT_DAY_OF_THE_MONTH_PARM_NAME

Fields inherited from class org.kuali.ole.fp.document.web.struts.VoucherForm

accountingPeriods, newSourceLineCredit, newSourceLineDebit, selectedAccountingPeriod, voucherLineHelpers

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

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAccountingPeriodCompositeValueList()
List<String>	getAccountingPeriodLabelList()
AuxiliaryVoucherDocument	getAuxiliaryVoucherDocument()
protected Date	getAvReversalDate() Gets today's date and then sets the day of the month as 15th, irrespective of the current day of the month
protected String	getDefaultDocumentTypeName()
String	getFormattedAuxiliaryVoucherType() Returns a formatted auxiliary voucher type: ()
String	getFormattedReversalDate() This method returns the reversal date in the format MMM d, yyyy.
String	getOriginalVoucherType()
protected int	getReversalDateDefaultDayOfMonth() get the reversal date default day of month defined as an application parameter
void	populate(javax.servlet.http.HttpServletRequest request) Overrides the parent to call super.populate and then to call the two methods that are specific to loading the two select lists on the page.
void	populateAccountingPeriodListForRendering() This method generates a proper list of valid accounting periods that the user can select from.
void	populateReversalDateForRendering() Handles special case display rules for displaying Reversal Date at UI layer
void	setAuxiliaryVoucherDocument(AuxiliaryVoucherDocument auxiliaryVoucherDocument)
void	setOriginalVoucherType(String originalVoucherType)

Methods inherited from class org.kuali.ole.fp.document.web.struts.VoucherForm

getAccountingPeriod, getAccountingPeriods, getCurrencyFormattedCreditTotal, getCurrencyFormattedDebitTotal, getCurrencyFormattedTotal, getNewSourceLineCredit, getNewSourceLineDebit, getSelectedAccountingPeriod, getSelectedPostingPeriodCode, getSelectedPostingYear, getVoucherDocument, getVoucherLineHelper, getVoucherLineHelpers, populateCreditAndDebitAmounts, populateDefaultSelectedAccountingPeriod, populateSelectedVoucherAccountingPeriod, populateSourceAccountingLine, processDebitAndCreditForAllSourceLines, processDebitAndCreditForNewSourceLine, processDebitAndCreditForSourceLine, setAccountingPeriods, setNewSourceLineCredit, setNewSourceLineDebit, setSelectedAccountingPeriod, setVoucherLineHelpers, validateCreditAndDebitAmounts

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

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

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

originalVoucherType

protected String originalVoucherType

REVERSAL_DATE_DEFAULT_DAY_OF_THE_MONTH_PARM_NAME

public static final String REVERSAL_DATE_DEFAULT_DAY_OF_THE_MONTH_PARM_NAME

See Also:

Constant Field Values

Constructor Detail

AuxiliaryVoucherForm

public AuxiliaryVoucherForm()

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class KualiDocumentFormBase

populate

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

Overrides the parent to call super.populate and then to call the two methods that are specific to loading the two select lists on the page. In addition, this also makes sure that the credit and debit amounts are filled in for situations where validation errors occur and the page reposts.

Specified by:

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

Overrides:

populate in class VoucherForm

See Also:

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

getAuxiliaryVoucherDocument

public AuxiliaryVoucherDocument getAuxiliaryVoucherDocument()

Returns:

Returns the serviceBillingDocument.

setAuxiliaryVoucherDocument

public void setAuxiliaryVoucherDocument(AuxiliaryVoucherDocument auxiliaryVoucherDocument)

Parameters:

serviceBillingDocument - The serviceBillingDocument to set.

getAvReversalDate

protected Date getAvReversalDate()

Gets today's date and then sets the day of the month as 15th, irrespective of the current day of the month

Returns:

the modified reversal date

populateReversalDateForRendering

public void populateReversalDateForRendering()

Handles special case display rules for displaying Reversal Date at UI layer

getFormattedReversalDate

public String getFormattedReversalDate()

This method returns the reversal date in the format MMM d, yyyy.

Overrides:

getFormattedReversalDate in class VoucherForm

Returns:

String

getOriginalVoucherType

public String getOriginalVoucherType()

Returns:

String

setOriginalVoucherType

public void setOriginalVoucherType(String originalVoucherType)

Parameters:

originalVoucherType -

getFormattedAuxiliaryVoucherType

public String getFormattedAuxiliaryVoucherType()

Returns a formatted auxiliary voucher type: ()

Returns:

populateAccountingPeriodListForRendering

public void populateAccountingPeriodListForRendering()

This method generates a proper list of valid accounting periods that the user can select from.

Overrides:

populateAccountingPeriodListForRendering in class VoucherForm

See Also:

VoucherForm.populateAccountingPeriodListForRendering()

getAccountingPeriodCompositeValueList

public List<String> getAccountingPeriodCompositeValueList()

getAccountingPeriodLabelList

public List<String> getAccountingPeriodLabelList()

getReversalDateDefaultDayOfMonth

protected int getReversalDateDefaultDayOfMonth()

get the reversal date default day of month defined as an application parameter