org.openmrs.web.controller.encounter

Class EncounterRoleFormController

java.lang.Object

org.openmrs.web.controller.encounter.EncounterRoleFormController

@Controller
 @RequestMapping(value="/admin/encounters")
public class EncounterRoleFormController
extends Object

This class controls the encounter.form jsp page. See /web/WEB-INF/view/admin/encounters/encounterForm.jsp

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EncounterRoleFormController()

Method Summary

Modifier and Type	Method and Description
EncounterRole	formBackingObject(Integer encounterRoleId)
String	getEncounterList(org.springframework.ui.ModelMap modelMap)
String	purge(javax.servlet.http.HttpSession session, EncounterRole encounterRole, org.springframework.validation.BindingResult errors)
String	retire(javax.servlet.http.HttpSession session, EncounterRole encounterRole, org.springframework.validation.BindingResult errors)
String	save(javax.servlet.http.HttpSession session, EncounterRole encounterRole, org.springframework.validation.BindingResult errors)
String	showForm()
String	unretire(javax.servlet.http.HttpSession session, EncounterRole encounterRole, org.springframework.validation.BindingResult errors)

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

EncounterRoleFormController

public EncounterRoleFormController()

Method Detail

save

@RequestMapping(value="/encounterRole.form",
                method=POST,
                params="saveEncounterRole")
public String save(javax.servlet.http.HttpSession session,
                                                                                                                                         @ModelAttribute(value="encounterRole")
                                                                                                                                         EncounterRole encounterRole,
                                                                                                                                         org.springframework.validation.BindingResult errors)
                                                                                                                                  throws Exception

Parameters:

session - HttpSession for the user

encounterRole - encounterRole object submitted from the form

errors - list of errors if exists @return logical view name to resolve

Throws:

Exception

Expected Behavior:

Should save a new encounter role object

Should raise an error if validation of encounter role fails

Should edit and save an existing encounter

retire

@RequestMapping(value="/encounterRole.form",
                method=POST,
                params="retire")
public String retire(javax.servlet.http.HttpSession session,
                                                                                                                                @ModelAttribute(value="encounterRole")
                                                                                                                                EncounterRole encounterRole,
                                                                                                                                org.springframework.validation.BindingResult errors)
                                                                                                                         throws Exception

Parameters:

session - HttpSession for the user

encounterRole - encounterRole object submitted from the form

errors - list of errors if exists @return logical view name to resolve

Throws:

Exception

Expected Behavior:

Should retire an existing encounter

Should raise an error if retire reason is not filled

unretire

@RequestMapping(value="/encounterRole.form",
                method=POST,
                params="unretire")
public String unretire(javax.servlet.http.HttpSession session,
                                                                                                                                    @ModelAttribute(value="encounterRole")
                                                                                                                                    EncounterRole encounterRole,
                                                                                                                                    org.springframework.validation.BindingResult errors)
                                                                                                                             throws Exception

Parameters:

session - HttpSession for the user

encounterRole - encounterRole object submitted from the form

errors - list of errors if exists @return logical view name to resolve

Throws:

Exception

Expected Behavior:

Should unretire an existing encounter

purge

@RequestMapping(value="/encounterRole.form",
                method=POST,
                params="purge")
public String purge(javax.servlet.http.HttpSession session,
                                                                                                                              @ModelAttribute(value="encounterRole")
                                                                                                                              EncounterRole encounterRole,
                                                                                                                              org.springframework.validation.BindingResult errors)
                                                                                                                       throws Exception

Parameters:

session - HttpSession for the user

encounterRole - encounterRole object submitted from the form

errors - list of errors if exists @return logical view name to resolve

Throws:

Exception

Expected Behavior:

Should retire and unretire an existing encounter

Should raise an error if retire reason is not filled

Should purge an existing encounter

formBackingObject

@ModelAttribute(value="encounterRole")
public EncounterRole formBackingObject(@RequestParam(required=false)
                                                                              Integer encounterRoleId)
                                                                       throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

showForm

@RequestMapping(value="/encounterRole.form",
                method=GET)
public String showForm()

getEncounterList

@RequestMapping(value="/encounterRole.list",
                method=GET)
public String getEncounterList(org.springframework.ui.ModelMap modelMap)

Parameters:

modelMap -

Returns:

logical view for the encounter list

Expected Behavior:

Should add list of encounter role objects to the model