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

Class KualiTransactionalDocumentFormBase

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

All Implemented Interfaces:

Serializable, PojoForm

Direct Known Subclasses:

BookOrderForm, IdentityManagementDocumentFormBase, TravelDocumentForm2

public class KualiTransactionalDocumentFormBase
extends KualiDocumentFormBase

This class is the base action form for all transactional documents.

See Also:

Serialized Form

Nested Class Summary

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

KualiForm.TabState

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	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
KualiTransactionalDocumentFormBase() This constructor sets up empty instances for the dependent objects...

Method Summary

Modifier and Type	Method and Description
protected String	discoverDocumentTypeName() Locates the DictionaryService to discover the type name of the document.
protected static String	formatReversalDate(Date reversalDate) This method formats the given java.sql.Date as MMM d, yyyy.
Map	getForcedReadOnlyFields() Gets the forcedReadOnlyFields attribute.
TransactionalDocument	getTransactionalDocument() This method retrieves an instance of the form.
protected TransactionalDocument	instantiateTransactionalDocumentByDocumentTypeName(String documentTypeName)
void	populate(javax.servlet.http.HttpServletRequest request) Setup workflow doc in the document.
protected void	populateEmptyMultiSelect(javax.servlet.http.HttpServletRequest request) Uses the "checkboxToReset" parameter to find checkboxes which had not been populated in the request and attempts to populate them
protected void	populateFalseCheckboxes(javax.servlet.http.HttpServletRequest request) Uses the "checkboxToReset" parameter to find checkboxes which had not been populated in the request and attempts to populate them
protected void	populationSpecialEmptyFields(javax.servlet.http.HttpServletRequest request)
void	setForcedReadOnlyFields(Map forcedReadOnlyFields) Sets the forcedReadOnlyFields attribute value.
boolean	shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, javax.servlet.http.HttpServletRequest request) This overridden method ...

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

addRequiredNonEditableProperties, buildHtmlLink, customInitMaxUploadSizes, getActionRequests, getActionRequestsRequiringApproval, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDefaultDocumentTypeName, 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, populateHeaderFields, 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, getExtraButtons, 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

forcedReadOnlyFields

protected Map forcedReadOnlyFields

Constructor Detail

KualiTransactionalDocumentFormBase

public KualiTransactionalDocumentFormBase()

This constructor sets up empty instances for the dependent objects...

Method Detail

populate

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

Description copied from class: KualiDocumentFormBase

Setup workflow doc in the document.

Specified by:

populate in interface PojoForm

Overrides:

populate in class KualiDocumentFormBase

See Also:

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

getTransactionalDocument

public TransactionalDocument getTransactionalDocument()

This method retrieves an instance of the form.

Returns:

discoverDocumentTypeName

protected String discoverDocumentTypeName()

Locates the DictionaryService to discover the type name of the document.

Returns:

formatReversalDate

protected static String formatReversalDate(Date reversalDate)

This method formats the given java.sql.Date as MMM d, yyyy.

Parameters:

reversalDate -

Returns:

String

getForcedReadOnlyFields

public Map getForcedReadOnlyFields()

Gets the forcedReadOnlyFields attribute.

Returns:

Returns the forcedReadOnlyFields.

setForcedReadOnlyFields

public void setForcedReadOnlyFields(Map forcedReadOnlyFields)

Sets the forcedReadOnlyFields attribute value.

Parameters:

forcedReadOnlyFields - The forcedReadOnlyFields to set.

populateFalseCheckboxes

protected void populateFalseCheckboxes(javax.servlet.http.HttpServletRequest request)

Uses the "checkboxToReset" parameter to find checkboxes which had not been populated in the request and attempts to populate them

Parameters:

request - the request to populate

populateEmptyMultiSelect

protected void populateEmptyMultiSelect(javax.servlet.http.HttpServletRequest request)

Uses the "checkboxToReset" parameter to find checkboxes which had not been populated in the request and attempts to populate them

Parameters:

request - the request to populate

populationSpecialEmptyFields

protected void populationSpecialEmptyFields(javax.servlet.http.HttpServletRequest request)

instantiateTransactionalDocumentByDocumentTypeName

protected TransactionalDocument instantiateTransactionalDocumentByDocumentTypeName(String documentTypeName)

shouldMethodToCallParameterBeUsed

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

This overridden method ...

Overrides:

shouldMethodToCallParameterBeUsed in class KualiDocumentFormBase

See Also:

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