Interface PojoForm
- All Known Implementing Classes:
InquiryForm,KualiDocumentFormBase,KualiExceptionIncidentForm,KualiFeedbackHandlerForm,KualiForm,KualiHelpForm,KualiMaintenanceForm,KualiTransactionalDocumentFormBase,LookupForm,MultipleValueLookupForm,PojoFormBase,QuestionPromptForm
Deprecated.
KNS Struts deprecated, use KRAD and the Spring MVC framework.
end Kuali Foundation modification
begin Kuali Foundation modification
This interface defines methods that Pojo Forms must provide.
-
Method Summary
Modifier and TypeMethodDescriptionvoidDeprecated.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.voidDeprecated.Reinitializes the form to allow it to register the editable properties of the currently processing request.formatValue(Object value, String keypath, Class type) Deprecated.Deprecated.booleanDeprecated.Deprecated.Returns a set of methodToCalls for which the system will bypass the session.Deprecated.Deprecated.voidpopulate(javax.servlet.http.HttpServletRequest request) Deprecated.voidpostprocessRequestParameters(Map requestParameters) Deprecated.voidDeprecated.voidregisterEditableProperty(String editablePropertyName) Deprecated.voidregisterIsNewForm(boolean isNewForm) Deprecated.voidDeprecated.Sets the value of the "scope" attribute for the Struts action mapping corresponding to this form instance.voidDeprecated.Sets the guid associated with the edited properties associated with the actionvoidDeprecated.Sets the editable properties guid for this formbooleanshouldPropertyBePopulatedInForm(String requestParameterName, javax.servlet.http.HttpServletRequest request) Deprecated.Returns whether a request parameter should be populated as a property of the form, assuming that the request parameter name corresponds to a property on the form.
-
Method Details
-
populate
void populate(javax.servlet.http.HttpServletRequest request) Deprecated. -
postprocessRequestParameters
Deprecated. -
getUnconvertedValues
Map getUnconvertedValues()Deprecated. -
formatValue
Deprecated. -
processValidationFail
void processValidationFail()Deprecated. -
getRequiredNonEditableProperties
Deprecated. -
registerEditableProperty
Deprecated. -
clearEditablePropertyInformation
void clearEditablePropertyInformation()Deprecated.Reinitializes the form to allow it to register the editable properties of the currently processing request. -
getEditableProperties
Deprecated. -
addRequiredNonEditableProperties
void addRequiredNonEditableProperties()Deprecated.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. -
registerStrutsActionMappingScope
Deprecated.Sets the value of the "scope" attribute for the Struts action mapping corresponding to this form instance. Note that this method name is NOT in the syntax of the conventional POJO setter; this is to prevent clients from maliciously altering the value of this parameter- Parameters:
scope-
-
registerIsNewForm
void registerIsNewForm(boolean isNewForm) Deprecated. -
getIsNewForm
boolean getIsNewForm()Deprecated. -
shouldPropertyBePopulatedInForm
boolean shouldPropertyBePopulatedInForm(String requestParameterName, javax.servlet.http.HttpServletRequest request) Deprecated.Returns whether a request parameter should be populated as a property of the form, assuming that the request parameter name corresponds to a property on the form. This method makes no determination whether the request parameter is a property of the form, but rather from a security perspective, whether the framework should attempt to set the form property with the same name as the request parameter.- Parameters:
requestParameterName- the name of the request parameterrequest- the HTTP request- Returns:
- whether the parameter should be
-
getMethodToCallsToBypassSessionRetrievalForGETRequests
Deprecated.Returns a set of methodToCalls for which the system will bypass the session. The return value of this method may depend ONLY upon the type of the class implementing it. Each instance of an implementation of this interface must return the same result. More formally, for 2 instances of this interfaces a1 and a2, if a1.getClass().equals(a2.getClass()), then a1.getMethodToCallsToBypassSessionRetrievalForGETRequests().equals(a2.getMethodToCallsToBypassSessionRetrievalForGETRequests()) NOTE: read Javadoc ofPojoFormBase.getMethodToCallsToBypassSessionRetrievalForGETRequests()for important implementation details.- Returns:
-
setPopulateEditablePropertiesGuid
Deprecated.Sets the editable properties guid for this form- Parameters:
guid- the key to the editable properties for this form
-
setActionEditablePropertiesGuid
Deprecated.Sets the guid associated with the edited properties associated with the action- Parameters:
guid- the guid of the action editable properties
-