org.openmrs.web.controller.program.ProgramFormController.java Source code

Introduction

Here is the source code for org.openmrs.web.controller.program.ProgramFormController.java

Source

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License,
 * v. 2.0. If a copy of the MPL was not distributed with this file, You can
 * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
 * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
 *
 * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
 * graphic logo is a trademark of OpenMRS Inc.
 */
package org.openmrs.web.controller.program;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openmrs.Concept;
import org.openmrs.Program;
import org.openmrs.api.ProgramWorkflowService;
import org.openmrs.api.context.Context;
import org.openmrs.propertyeditor.ConceptEditor;
import org.openmrs.propertyeditor.WorkflowCollectionEditor;
import org.openmrs.web.WebConstants;
import org.springframework.validation.BindException;
import org.springframework.web.bind.ServletRequestDataBinder;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.SimpleFormController;
import org.springframework.web.servlet.view.RedirectView;

public class ProgramFormController extends SimpleFormController {

    /** Logger for this class and subclasses */
    protected final Log log = LogFactory.getLog(getClass());

    protected void initBinder(HttpServletRequest request, ServletRequestDataBinder binder) throws Exception {
        super.initBinder(request, binder);

        // this depends on this form being a "session-form" (defined in openrms-servlet.xml)
        Program program = (Program) binder.getTarget();

        binder.registerCustomEditor(Concept.class, new ConceptEditor());
        binder.registerCustomEditor(java.util.Collection.class, "allWorkflows",
                new WorkflowCollectionEditor(program));
    }

    /**
     * This is called prior to displaying a form for the first time. It tells Spring the
     * form/command object to load into the request
     *
     * @see org.springframework.web.servlet.mvc.AbstractFormController#formBackingObject(javax.servlet.http.HttpServletRequest)
     */
    protected Object formBackingObject(HttpServletRequest request) throws ServletException {
        log.debug("called formBackingObject");

        Program program = null;

        if (Context.isAuthenticated()) {
            ProgramWorkflowService ps = Context.getProgramWorkflowService();
            String programId = request.getParameter("programId");
            if (programId != null) {
                program = ps.getProgram(Integer.valueOf(programId));
            }
        }

        if (program == null) {
            program = new Program();
        }

        return program;
    }

    /**
     * The onSubmit function receives the form/command object that was modified by the input form
     * and saves it to the db
     *
     * @see org.springframework.web.servlet.mvc.SimpleFormController#onSubmit(javax.servlet.http.HttpServletRequest,
     *      javax.servlet.http.HttpServletResponse, java.lang.Object,
     *      org.springframework.validation.BindException)
     * @should save workflows with program
     * @should edit existing workflows within programs
     */
    protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object obj,
            BindException errors) throws Exception {
        log.debug("about to save " + obj);

        HttpSession httpSession = request.getSession();

        String view = getFormView();

        if (Context.isAuthenticated()) {
            Program p = (Program) obj;
            try {
                Context.getProgramWorkflowService().saveProgram(p);
            } catch (Exception e) {
                log.warn("Error saving Program", e);
                httpSession.setAttribute(WebConstants.OPENMRS_ERROR_ATTR, e.getMessage());
            }
            view = getSuccessView();
        }

        return new ModelAndView(new RedirectView(view));
    }

}