org.openmrs.web.controller.program

Class ProgramListController

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.AbstractController

org.springframework.web.servlet.mvc.BaseCommandController

org.springframework.web.servlet.mvc.AbstractFormController

org.springframework.web.servlet.mvc.SimpleFormController

org.openmrs.web.controller.program.ProgramListController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

public class ProgramListController
extends org.springframework.web.servlet.mvc.SimpleFormController

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log Logger for this class and subclasses

Fields inherited from class org.springframework.web.servlet.mvc.BaseCommandController

DEFAULT_COMMAND_NAME

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

Constructors

Constructor and Description
ProgramListController()

Method Summary

Modifier and Type	Method and Description
protected Object	formBackingObject(javax.servlet.http.HttpServletRequest request) This is called prior to displaying a form for the first time.
protected org.springframework.web.servlet.ModelAndView	onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object obj, org.springframework.validation.BindException errors) Submit callback with all parameters.

Methods inherited from class org.springframework.web.servlet.mvc.SimpleFormController

doSubmitAction, getFormView, getSuccessView, isFormChangeRequest, isFormChangeRequest, onFormChange, onFormChange, onSubmit, onSubmit, processFormSubmission, referenceData, referenceData, setFormView, setSuccessView, showForm, showForm, suppressValidation

Methods inherited from class org.springframework.web.servlet.mvc.AbstractFormController

currentFormObject, getCommand, getErrorsForNewForm, getFormSessionAttributeName, getFormSessionAttributeName, handleInvalidSubmit, handleRequestInternal, isBindOnNewForm, isFormSubmission, isSessionForm, onBindOnNewForm, onBindOnNewForm, setBindOnNewForm, setSessionForm, showForm, showForm, showNewForm

Methods inherited from class org.springframework.web.servlet.mvc.BaseCommandController

bindAndValidate, checkCommand, createBinder, createCommand, getBindingErrorProcessor, getCommandClass, getCommandName, getMessageCodesResolver, getPropertyEditorRegistrars, getValidator, getValidators, getWebBindingInitializer, initApplicationContext, initBinder, isValidateOnBinding, onBind, onBind, onBindAndValidate, prepareBinder, setBindingErrorProcessor, setCommandClass, setCommandName, setMessageCodesResolver, setPropertyEditorRegistrar, setPropertyEditorRegistrars, setValidateOnBinding, setValidator, setValidators, setWebBindingInitializer, suppressBinding, suppressValidation, suppressValidation, useDirectFieldAccess

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected final org.apache.commons.logging.Log log

Logger for this class and subclasses

Constructor Detail

ProgramListController

public ProgramListController()

Method Detail

formBackingObject

protected Object formBackingObject(javax.servlet.http.HttpServletRequest request)
                            throws javax.servlet.ServletException

This is called prior to displaying a form for the first time. It tells Spring the form/command object to load into the request

Overrides:

formBackingObject in class org.springframework.web.servlet.mvc.AbstractFormController

Parameters:

request - current HTTP request

Returns:

the backing object

Throws:

javax.servlet.ServletException

See Also:

AbstractFormController.formBackingObject(javax.servlet.http.HttpServletRequest)

onSubmit

protected org.springframework.web.servlet.ModelAndView onSubmit(javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response,
                                                                Object obj,
                                                                org.springframework.validation.BindException errors)
                                                         throws Exception

Description copied from class: org.springframework.web.servlet.mvc.SimpleFormController

Submit callback with all parameters. Called in case of submit without errors reported by the registered validator, or on every submit if no validator.

The default implementation delegates to SimpleFormController.onSubmit(Object, BindException). For simply performing a submit action and rendering the specified success view, consider implementing SimpleFormController.doSubmitAction(java.lang.Object) rather than an onSubmit variant.

Subclasses can override this to provide custom submission handling like storing the object to the database. Implementations can also perform custom validation and call showForm to return to the form. Do not implement multiple onSubmit methods: In that case, just this method will be called by the controller.

Call errors.getModel() to populate the ModelAndView model with the command and the Errors instance, under the specified command name, as expected by the "spring:bind" tag.

Overrides:

onSubmit in class org.springframework.web.servlet.mvc.SimpleFormController

Parameters:

request - current servlet request

response - current servlet response

obj - form object with request parameters bound onto it

errors - Errors instance without errors (subclass can add errors if it wants to)

Returns:

the prepared model and view, or null

Throws:

Exception - in case of errors

See Also:

SimpleFormController.onSubmit(Object, BindException), SimpleFormController.doSubmitAction(java.lang.Object), SimpleFormController.showForm(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.springframework.validation.BindException), Errors, BindException.getModel()