/**
* The contents of this file are subject to the OpenMRS Public License
* Version 1.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://license.openmrs.org
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
* License for the specific language governing rights and limitations
* under the License.
*
* Copyright (C) OpenMRS, LLC. All Rights Reserved.
*/
package org.openmrs.web.controller.order;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openmrs.Concept;
import org.openmrs.Encounter;
import org.openmrs.Order;
import org.openmrs.OrderType;
import org.openmrs.Patient;
import org.openmrs.User;
import org.openmrs.api.APIException;
import org.openmrs.api.OrderService;
import org.openmrs.api.context.Context;
import org.openmrs.propertyeditor.ConceptEditor;
import org.openmrs.propertyeditor.EncounterEditor;
import org.openmrs.propertyeditor.OrderTypeEditor;
import org.openmrs.propertyeditor.PatientEditor;
import org.openmrs.propertyeditor.UserEditor;
import org.openmrs.util.OpenmrsUtil;
import org.openmrs.web.WebConstants;
import org.springframework.beans.propertyeditors.CustomBooleanEditor;
import org.springframework.beans.propertyeditors.CustomDateEditor;
import org.springframework.beans.propertyeditors.CustomNumberEditor;
import org.springframework.validation.BindException;
import org.springframework.validation.Errors;
import org.springframework.web.bind.ServletRequestDataBinder;
import org.springframework.web.bind.ServletRequestUtils;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.SimpleFormController;
import org.springframework.web.servlet.view.RedirectView;
public class OrderFormController extends SimpleFormController {
/** Logger for this class and subclasses */
protected final Log log = LogFactory.getLog(getClass());
/**
* Allows for Integers to be used as values in input tags. Normally, only strings and lists are
* expected
*
* @see org.springframework.web.servlet.mvc.BaseCommandController#initBinder(javax.servlet.http.HttpServletRequest,
* org.springframework.web.bind.ServletRequestDataBinder)
*/
protected void initBinder(HttpServletRequest request, ServletRequestDataBinder binder) throws Exception {
super.initBinder(request, binder);
binder.registerCustomEditor(OrderType.class, new OrderTypeEditor());
binder.registerCustomEditor(Boolean.class, new CustomBooleanEditor("t", "f", true));
binder.registerCustomEditor(Integer.class, new CustomNumberEditor(Integer.class, true));
binder.registerCustomEditor(Concept.class, new ConceptEditor());
binder.registerCustomEditor(Date.class, new CustomDateEditor(Context.getDateFormat(), true));
binder.registerCustomEditor(User.class, new UserEditor());
binder.registerCustomEditor(Patient.class, new PatientEditor());
binder.registerCustomEditor(Encounter.class, new EncounterEditor());
}
/**
* @see org.springframework.web.servlet.mvc.SimpleFormController#referenceData(javax.servlet.http.HttpServletRequest,
* java.lang.Object, org.springframework.validation.Errors)
*/
@Override
protected Map<String, Object> referenceData(HttpServletRequest request, Object command, Errors errors) throws Exception {
Map<String, Object> refData = new HashMap<String, Object>();
return refData;
}
/*
* executes one of the following commands encoded in the request parameter
* on the order parameter:
* saveOrder, voidOrder, unvoidOrder, discontinueOrder, undiscontinueOrder
* Returns true if the command execution succeeded.
*/
protected boolean executeCommand(Order order, HttpServletRequest request) {
if (!Context.isAuthenticated()) {
return false;
}
OrderService orderService = Context.getOrderService();
try {
if (request.getParameter("saveOrder") != null) {
orderService.saveOrder(order);
request.getSession().setAttribute(WebConstants.OPENMRS_MSG_ATTR, "Order.saved");
} else if (request.getParameter("voidOrder") != null) {
orderService.voidOrder(order, order.getVoidReason());
request.getSession().setAttribute(WebConstants.OPENMRS_MSG_ATTR, "Order.voidedSuccessfully");
} else if (request.getParameter("unvoidOrder") != null) {
orderService.unvoidOrder(order);
request.getSession().setAttribute(WebConstants.OPENMRS_MSG_ATTR, "Order.unvoidedSuccessfully");
} else if (request.getParameter("discontinueOrder") != null) {
orderService.discontinueOrder(order, order.getDiscontinuedReason(), order.getDiscontinuedDate());
request.getSession().setAttribute(WebConstants.OPENMRS_MSG_ATTR, "Order.discontinuedSuccessfully");
} else if (request.getParameter("undiscontinueOrder") != null) {
orderService.undiscontinueOrder(order);
request.getSession().setAttribute(WebConstants.OPENMRS_MSG_ATTR, "Order.undiscontinuedSuccessfully");
}
}
catch (APIException ex) {
request.getSession().setAttribute(WebConstants.OPENMRS_ERROR_ATTR, ex.getMessage());
return false;
}
return true;
}
/**
* 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 {
String view;
Order order = (Order) obj;
boolean ok = executeCommand(order, request);
if (ok) {
view = getSuccessView();
} else {
return showForm(request, response, errors);
}
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 {
OrderService os = Context.getOrderService();
Order order = null;
if (Context.isAuthenticated()) {
Integer orderId = ServletRequestUtils.getIntParameter(request, "orderId");
if (orderId != null)
order = os.getOrder(orderId);
}
// if this is a new order, let's see if the user has picked a type yet
if (order == null) {
order = new Order();
Integer orderTypeId = ServletRequestUtils.getIntParameter(request, "orderTypeId");
if (orderTypeId != null) {
OrderType ot = os.getOrderType(orderTypeId);
order.setOrderType(ot);
}
}
return order;
}
}