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

Class KualiMaintenanceForm

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.KualiMaintenanceForm
All Implemented Interfaces:
Serializable, PojoForm
@Deprecated public class KualiMaintenanceForm extends KualiDocumentFormBase
Deprecated.
Use MaintenanceDocumentForm.
This class is the base action form for all maintenance documents.
See Also:

  • Field Details

    • LOG

      protected static final org.apache.logging.log4j.Logger LOG
      Deprecated.

    • serialVersionUID

      protected static final long serialVersionUID
      Deprecated.
      See Also:

    • businessObjectClassName

      protected String businessObjectClassName
      Deprecated.

    • description

      protected String description
      Deprecated.

    • readOnly

      protected boolean readOnly
      Deprecated.

    • oldMaintainableValues

      protected Map<String,String> oldMaintainableValues
      Deprecated.

    • newMaintainableValues

      protected Map<String,String> newMaintainableValues
      Deprecated.

    • maintenanceAction

      protected String maintenanceAction
      Deprecated.

    • lookupResultsSequenceNumber

      protected String lookupResultsSequenceNumber
      Deprecated.
      Used to indicate which result set we're using when refreshing/returning from a multi-value lookup

    • lookupResultsBOClassName

      protected String lookupResultsBOClassName
      Deprecated.
      The type of result returned by the multi-value lookup TODO: to be persisted in the lookup results service instead?

    • lookedUpCollectionName

      protected String lookedUpCollectionName
      Deprecated.
      The name of the collection looked up (by a multiple value lookup)

    • authorizations

      protected MaintenanceDocumentRestrictions authorizations
      Deprecated.

  • Constructor Details

    • KualiMaintenanceForm

      public KualiMaintenanceForm()
      Deprecated.

  • Method Details

    • addRequiredNonEditableProperties

      public void addRequiredNonEditableProperties()
      Deprecated.
      Description copied from interface: PojoForm
      This method adds the required property names, that are not directly editable by user on the html page, to a list, regardless of the context in which they appear. Request parameter names corresponding to these properties will be populated into the form.
      Specified by:
      addRequiredNonEditableProperties in interface PojoForm
      Overrides:
      addRequiredNonEditableProperties in class KualiDocumentFormBase
      See Also:

    • postprocessRequestParameters

      public void postprocessRequestParameters(Map requestParameters)
      Deprecated.
      Override the default method to add the if statement which can't be called until after parameters from a multipart request have been made accessible, but which must be called before the parameter values are used to instantiate and populate business objects.
      Specified by:
      postprocessRequestParameters in interface PojoForm
      Overrides:
      postprocessRequestParameters in class PojoFormBase
      Parameters:
      requestParameters -

    • populate

      public void populate(javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Hook into populate so we can set the maintenance documents and feed the field values to its maintainables.
      Specified by:
      populate in interface PojoForm
      Overrides:
      populate in class KualiDocumentFormBase

    • populateAttachmentPropertyForBO

      protected void populateAttachmentPropertyForBO(MaintenanceDocumentBase maintenanceDocument)
      Deprecated.

    • getSections

      public List getSections()
      Deprecated.
      Merges rows of old and new for each section (tab) of the ui. Also, renames fields to prevent naming conflicts and does setting of read only fields.
      Returns:
      Returns the maintenanceSections.

    • getMaintenanceAction

      public String getMaintenanceAction()
      Deprecated.

    • getBusinessObjectClassName

      public String getBusinessObjectClassName()
      Deprecated.

    • setBusinessObjectClassName

      public void setBusinessObjectClassName(String businessObjectClassName)
      Deprecated.

    • getDescription

      public String getDescription()
      Deprecated.

    • setDescription

      public void setDescription(String description)
      Deprecated.

    • isReadOnly

      public boolean isReadOnly()
      Deprecated.

    • setReadOnly

      public void setReadOnly(boolean readOnly)
      Deprecated.

    • getNewMaintainableValues

      public Map getNewMaintainableValues()
      Deprecated.

    • getOldMaintainableValues

      public Map getOldMaintainableValues()
      Deprecated.

    • setMaintenanceAction

      public void setMaintenanceAction(String maintenanceAction)
      Deprecated.

    • getAuthorizations

      public MaintenanceDocumentRestrictions getAuthorizations()
      Deprecated.

    • setAuthorizations

      public void setAuthorizations(MaintenanceDocumentRestrictions authorizations)
      Deprecated.

    • setNewMaintainableValues

      public void setNewMaintainableValues(Map newMaintainableValues)
      Deprecated.

    • setOldMaintainableValues

      public void setOldMaintainableValues(Map oldMaintainableValues)
      Deprecated.

    • getLookupResultsSequenceNumber

      public String getLookupResultsSequenceNumber()
      Deprecated.

    • setLookupResultsSequenceNumber

      public void setLookupResultsSequenceNumber(String lookupResultsSequenceNumber)
      Deprecated.

    • getLookupResultsBOClassName

      public String getLookupResultsBOClassName()
      Deprecated.

    • setLookupResultsBOClassName

      public void setLookupResultsBOClassName(String lookupResultsBOClassName)
      Deprecated.

    • getLookedUpCollectionName

      public String getLookedUpCollectionName()
      Deprecated.

    • setLookedUpCollectionName

      public void setLookedUpCollectionName(String lookedUpCollectionName)
      Deprecated.

    • getAdditionalSectionsFile

      public String getAdditionalSectionsFile()
      Deprecated.

    • retrieveFormValueForLookupInquiryParameters

      public String retrieveFormValueForLookupInquiryParameters(String parameterName, String parameterValueLocation)
      Deprecated.
      This overridden method handles the case where maint doc properties do not reflect the true nature of the
      Overrides:
      retrieveFormValueForLookupInquiryParameters in class KualiForm
      Parameters:
      parameterName - the name of the parameter, as expected by the lookup or inquiry frameworks
      parameterValueLocation - the name of the property containing the value of the parameter
      Returns:
      the value of the parameter
      See Also:

    • parseAddCollectionName

      protected String parseAddCollectionName(String propertyName)
      Deprecated.
      This method returns the collection name (including nested collections) from a propertyName string
      Parameters:
      propertyName - a parameterValueLocation w/ KRADConstants.MAINTENANCE_NEW_MAINTAINABLE + KRADConstants.ADD_PREFIX + "." stripped off the front
      Returns:
      the collectionName

    • shouldPropertyBePopulatedInForm

      public boolean shouldPropertyBePopulatedInForm(String requestParameterName, javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Description copied from class: KualiDocumentFormBase
      IMPORTANT: any overrides of this method must ensure that nothing in the HTTP request will be used to determine whether document is in session
      Specified by:
      shouldPropertyBePopulatedInForm in interface PojoForm
      Overrides:
      shouldPropertyBePopulatedInForm in class KualiDocumentFormBase
      Parameters:
      requestParameterName - the name of the request parameter
      request - the HTTP request
      Returns:
      whether the parameter should be
      See Also:

    • shouldMethodToCallParameterBeUsed

      public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Overrides:
      shouldMethodToCallParameterBeUsed in class KualiDocumentFormBase