Package org.motechproject.mots.web

Class ModuleController

java.lang.Object

org.motechproject.mots.web.BaseController

org.motechproject.mots.web.ModuleController

@Controller
public class ModuleController
extends BaseController

This class is responsible for CURD operations.

Constructor Summary

Constructors

Constructor	Description
ModuleController()

Method Summary

Modifier and Type	Method	Description
ModuleDto	copyModule(java.util.UUID id)	Copy Module as a new draft.
CourseDto	createCourse()	Create Course.
ModuleDto	createModule(@Valid ModuleDto moduleDto, org.springframework.validation.BindingResult bindingResult)	Create Module.
java.util.List<CourseDto>	getCourses()	Get list of Courses.
java.util.List<ModuleSimpleDto>	getSimpleModules()	Get list of Module Simple DTOs.
CourseDto	releaseCourse(java.util.UUID id)	Release Course.
CourseDto	updateCourse(java.util.UUID id, @Valid CourseDto courseDto, org.springframework.validation.BindingResult bindingResult)	Update Course.
ModuleDto	updateModule(java.util.UUID id, @Valid ModuleDto moduleDto, org.springframework.validation.BindingResult bindingResult)	Update Module.

Methods inherited from class org.motechproject.mots.web.BaseController

checkBindingResult, getErrors

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleController

public ModuleController()

Method Detail

getSimpleModules

@RequestMapping(value="/modules/simple",
                method=GET)
@ResponseStatus(OK)
@ResponseBody
public java.util.List<ModuleSimpleDto> getSimpleModules()

Get list of Module Simple DTOs.

Returns:

list of all Modules

createModule

@RequestMapping(value="/modules",
                method=POST)
@ResponseStatus(CREATED)
@ResponseBody
public ModuleDto createModule(@RequestBody @Valid
                              @Valid ModuleDto moduleDto,
                              org.springframework.validation.BindingResult bindingResult)

Create Module.

Parameters:

moduleDto - DTO of Module to create

bindingResult - spring object used for validation

Returns:

created Module

updateModule

@RequestMapping(value="/modules/{id}",
                method=PUT)
@ResponseStatus(OK)
@ResponseBody
public ModuleDto updateModule(@PathVariable("id")
                              java.util.UUID id,
                              @RequestBody @Valid
                              @Valid ModuleDto moduleDto,
                              org.springframework.validation.BindingResult bindingResult)

Update Module.

Parameters:

id - id of Module to update

moduleDto - DTO of Module to update

bindingResult - spring object used for validation

Returns:

updated Module

copyModule

@RequestMapping(value="/modules/{id}/edit",
                method=PUT)
@ResponseStatus(OK)
@ResponseBody
public ModuleDto copyModule(@PathVariable("id")
                            java.util.UUID id)

Copy Module as a new draft.

Parameters:

id - id of Module to update

Returns:

copy of Module to be edited

getCourses

@RequestMapping(value="/courses",
                method=GET)
@ResponseStatus(OK)
@ResponseBody
public java.util.List<CourseDto> getCourses()

Get list of Courses.

Returns:

list of all Courses

createCourse

@RequestMapping(value="/courses",
                method=POST)
@ResponseStatus(CREATED)
@ResponseBody
public CourseDto createCourse()

Create Course.

Returns:

created Course

updateCourse

@RequestMapping(value="/courses/{id}",
                method=PUT)
@ResponseStatus(OK)
@ResponseBody
public CourseDto updateCourse(@PathVariable("id")
                              java.util.UUID id,
                              @RequestBody @Valid
                              @Valid CourseDto courseDto,
                              org.springframework.validation.BindingResult bindingResult)

Update Course.

Parameters:

id - id of Course to update

courseDto - DTO of Course to update

bindingResult - spring object used for validation

Returns:

updated Course

releaseCourse

@RequestMapping(value="/courses/{id}/release",
                method=PUT)
@ResponseStatus(OK)
@ResponseBody
public CourseDto releaseCourse(@PathVariable("id")
                               java.util.UUID id)

Release Course.

Parameters:

id - id of Course to release

Returns:

released Course