org.openmrs.web.controller.form.FormListController.java Source code

Introduction

Here is the source code for org.openmrs.web.controller.form.FormListController.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.form;

import java.util.List;
import java.util.Vector;

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.Form;
import org.openmrs.api.APIException;
import org.openmrs.api.FormService;
import org.openmrs.api.context.Context;
import org.openmrs.web.WebConstants;
import org.springframework.context.support.MessageSourceAccessor;
import org.springframework.validation.BindException;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.SimpleFormController;
import org.springframework.web.servlet.view.RedirectView;

public class FormListController extends SimpleFormController {

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

    /**
     * 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)
     */
    protected ModelAndView onSubmit(HttpServletRequest request, HttpServletResponse response, Object obj,
            BindException errors) throws Exception {

        HttpSession httpSession = request.getSession();

        String view = getFormView();
        if (Context.isAuthenticated()) {
            String[] formList = request.getParameterValues("formId");
            FormService fs = Context.getFormService();
            //FormService rs = new TestFormService();

            StringBuilder success = new StringBuilder("");
            StringBuilder error = new StringBuilder("");

            MessageSourceAccessor msa = getMessageSourceAccessor();
            String deleted = msa.getMessage("general.deleted");
            String notDeleted = msa.getMessage("general.cannot.delete");
            String textForm = msa.getMessage("Form.form");
            String noneDeleted = msa.getMessage("Form.nonedeleted");
            if (formList != null) {
                for (String p : formList) {
                    //TODO convenience method deleteForm(Integer) ??
                    try {
                        fs.purgeForm(fs.getForm(Integer.valueOf(p)));
                        if (!"".equals(success.toString())) {
                            success.append("<br/>");
                        }
                        success.append(textForm).append(" ").append(p).append(" ").append(deleted);
                    } catch (APIException e) {
                        log.warn("Error deleting form", e);
                        if (!"".equals(error.toString())) {
                            error.append("<br/>");
                        }
                        error.append(textForm).append(" ").append(p).append(" ").append(notDeleted);
                    }
                }
            } else {
                success.append(noneDeleted);
            }
            view = getSuccessView();
            if (!"".equals(success.toString())) {
                httpSession.setAttribute(WebConstants.OPENMRS_MSG_ATTR, success.toString());
            }
            if (!"".equals(error.toString())) {
                httpSession.setAttribute(WebConstants.OPENMRS_ERROR_ATTR, error.toString());
            }
        }

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

    /**
     * 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 {

        //default empty Object
        List<Form> formList = new Vector<Form>();

        //only fill the Object is the user has authenticated properly
        if (Context.isAuthenticated()) {
            FormService fs = Context.getFormService();
            //FormService rs = new TestFormService();
            formList = fs.getAllForms();
        }

        return formList;
    }
}