com.clusterra.pmbok.rest.template

Class TemplateController

java.lang.Object

com.clusterra.pmbok.rest.template.TemplateController

@RestController
 @RequestMapping(value="pmbok/templates",
                produces="application/json")
public class TemplateController
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TemplateController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<SectionTemplateResource>	addContentsSection(java.lang.String id, java.util.Locale locale)
org.springframework.http.ResponseEntity<SectionTemplateResource>	addHistorySection(java.lang.String id, java.util.Locale locale)
org.springframework.http.ResponseEntity<SectionTemplateResource>	addReferenceSection(java.lang.String id, java.util.Locale locale)
org.springframework.http.ResponseEntity<SectionTemplateResource>	addTermSection(java.lang.String id, java.util.Locale locale)
org.springframework.http.ResponseEntity<SectionTemplateResource>	addTextSection(java.lang.String id, java.util.Locale locale)
org.springframework.http.ResponseEntity<SectionTemplateResource>	addTitleSection(java.lang.String id, java.util.Locale locale)
org.springframework.http.ResponseEntity<TemplateResource>	create(TemplatePod pod, org.springframework.validation.BindingResult bindingResult)
org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable>	delete(java.lang.String id)
org.springframework.http.ResponseEntity<TemplateResource>	get(java.lang.String id)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<SectionTypeResource>>	getAvailableSectionTypes(java.lang.String id)
org.springframework.http.ResponseEntity<SectionTemplateResource>	getSection(java.lang.String id, java.lang.String sectionTemplateId)
org.springframework.http.ResponseEntity<java.util.List<SectionTemplateResource>>	getSections(java.lang.String id)
org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable>	removeSection(java.lang.String id, java.lang.String sectionTemplateId)
org.springframework.http.ResponseEntity<org.springframework.hateoas.PagedResources<TemplateResource>>	search(org.springframework.data.domain.Pageable pageable, java.lang.String searchBy, org.springframework.data.web.PagedResourcesAssembler<com.clusterra.pmbok.document.domain.model.template.Template> assembler)
org.springframework.http.ResponseEntity<SectionTemplateResource>	updateSectionName(java.lang.String id, java.lang.String sectionTemplateId, NamePod pod)
org.springframework.http.ResponseEntity<SectionTemplateResource>	updateSectionOrder(java.lang.String id, java.lang.String sectionTemplateId, SectionOrderPod pod)
org.springframework.http.ResponseEntity<TemplateResource>	updateTemplateName(java.lang.String id, NamePod pod)

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateController

public TemplateController()

Method Detail

create

@RequestMapping(value="",
                method=POST)
public org.springframework.http.ResponseEntity<TemplateResource> create(@RequestBody
                                                                                                                               TemplatePod pod,
                                                                                                                               org.springframework.validation.BindingResult bindingResult)
                                                                                                                        throws org.springframework.validation.BindException,
                                                                                                                               com.clusterra.iam.core.application.tracker.NotAuthenticatedException,
                                                                                                                               com.clusterra.pmbok.document.domain.service.template.TemplateAlreadyExistsException

Throws:

org.springframework.validation.BindException

com.clusterra.iam.core.application.tracker.NotAuthenticatedException

com.clusterra.pmbok.document.domain.service.template.TemplateAlreadyExistsException

updateTemplateName

@RequestMapping(value="/{id}",
                method=PUT)
public org.springframework.http.ResponseEntity<TemplateResource> updateTemplateName(@PathVariable
                                                                                                                                               java.lang.String id,
                                                                                                                                               @RequestBody
                                                                                                                                               NamePod pod)
                                                                                                                                        throws com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

delete

@RequestMapping(value="/{id}",
                method=DELETE)
public org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable> delete(@PathVariable
                                                                                                                                                                                        java.lang.String id)
                                                                                                                                                                                 throws com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

get

@RequestMapping(value="/{id}",
                method=GET)
public org.springframework.http.ResponseEntity<TemplateResource> get(@PathVariable
                                                                                                                                java.lang.String id)
                                                                                                                         throws com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

addHistorySection

@RequestMapping(value="/{id}/sections/add-history",
                method=POST)
public org.springframework.http.ResponseEntity<SectionTemplateResource> addHistorySection(@PathVariable
                                                                                                                                                                           java.lang.String id,
                                                                                                                                                                           java.util.Locale locale)
                                                                                                                                                                    throws com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException,
                                                                                                                                                                           com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

addReferenceSection

@RequestMapping(value="/{id}/sections/add-reference",
                method=POST)
public org.springframework.http.ResponseEntity<SectionTemplateResource> addReferenceSection(@PathVariable
                                                                                                                                                                               java.lang.String id,
                                                                                                                                                                               java.util.Locale locale)
                                                                                                                                                                        throws com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException,
                                                                                                                                                                               com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

addTermSection

@RequestMapping(value="/{id}/sections/add-term",
                method=POST)
public org.springframework.http.ResponseEntity<SectionTemplateResource> addTermSection(@PathVariable
                                                                                                                                                                     java.lang.String id,
                                                                                                                                                                     java.util.Locale locale)
                                                                                                                                                              throws com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException,
                                                                                                                                                                     com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

addTextSection

@RequestMapping(value="/{id}/sections/add-text",
                method=POST)
public org.springframework.http.ResponseEntity<SectionTemplateResource> addTextSection(@PathVariable
                                                                                                                                                                     java.lang.String id,
                                                                                                                                                                     java.util.Locale locale)
                                                                                                                                                              throws com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException,
                                                                                                                                                                     com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

addContentsSection

@RequestMapping(value="/{id}/sections/add-contents",
                method=POST)
public org.springframework.http.ResponseEntity<SectionTemplateResource> addContentsSection(@PathVariable
                                                                                                                                                                             java.lang.String id,
                                                                                                                                                                             java.util.Locale locale)
                                                                                                                                                                      throws com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException,
                                                                                                                                                                             com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

addTitleSection

@RequestMapping(value="/{id}/sections/add-title",
                method=POST)
public org.springframework.http.ResponseEntity<SectionTemplateResource> addTitleSection(@PathVariable
                                                                                                                                                                       java.lang.String id,
                                                                                                                                                                       java.util.Locale locale)
                                                                                                                                                                throws com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException,
                                                                                                                                                                       com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.model.template.SectionTemplateAlreadyExistsException

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

removeSection

@RequestMapping(value="/{id}/sections/{sectionTemplateId}",
                method=DELETE)
public org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable> removeSection(@PathVariable
                                                                                                                                                                                                                            java.lang.String id,
                                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                                            java.lang.String sectionTemplateId)
                                                                                                                                                                                                                     throws com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException,
                                                                                                                                                                                                                            com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

getSection

@RequestMapping(value="/{id}/sections/{sectionTemplateId}",
                method=GET)
public org.springframework.http.ResponseEntity<SectionTemplateResource> getSection(@PathVariable
                                                                                                                                                                           java.lang.String id,
                                                                                                                                                                           @PathVariable
                                                                                                                                                                           java.lang.String sectionTemplateId)
                                                                                                                                                                    throws com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException,
                                                                                                                                                                           com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

getSections

@RequestMapping(value="/{id}/sections",
                method=GET)
public org.springframework.http.ResponseEntity<java.util.List<SectionTemplateResource>> getSections(@PathVariable
                                                                                                                                                                        java.lang.String id)
                                                                                                                                                                 throws com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

updateSectionOrder

@RequestMapping(value="/{id}/sections/{sectionTemplateId}/update-order",
                method=PUT)
public org.springframework.http.ResponseEntity<SectionTemplateResource> updateSectionOrder(@PathVariable
                                                                                                                                                                                                java.lang.String id,
                                                                                                                                                                                                @PathVariable
                                                                                                                                                                                                java.lang.String sectionTemplateId,
                                                                                                                                                                                                @RequestBody
                                                                                                                                                                                                SectionOrderPod pod)
                                                                                                                                                                                         throws com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException,
                                                                                                                                                                                                com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

updateSectionName

@RequestMapping(value="/{id}/sections/{sectionTemplateId}/update-name",
                method=PUT)
public org.springframework.http.ResponseEntity<SectionTemplateResource> updateSectionName(@PathVariable
                                                                                                                                                                                              java.lang.String id,
                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                              java.lang.String sectionTemplateId,
                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                              NamePod pod)
                                                                                                                                                                                       throws com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException,
                                                                                                                                                                                              com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

search

@RequestMapping(value="/search",
                method=GET)
public org.springframework.http.ResponseEntity<org.springframework.hateoas.PagedResources<TemplateResource>> search(@PageableDefault
                                                                                                                                                                                 org.springframework.data.domain.Pageable pageable,
                                                                                                                                                                                 @RequestParam(required=false)
                                                                                                                                                                                 java.lang.String searchBy,
                                                                                                                                                                                 org.springframework.data.web.PagedResourcesAssembler<com.clusterra.pmbok.document.domain.model.template.Template> assembler)
                                                                                                                                                                          throws com.clusterra.iam.core.application.tracker.NotAuthenticatedException

Throws:

com.clusterra.iam.core.application.tracker.NotAuthenticatedException

getAvailableSectionTypes

@RequestMapping(value="/{id}/available-section-types")
public org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<SectionTypeResource>> getAvailableSectionTypes(@PathVariable
                                                                                                                                                                                           java.lang.String id)
                                                                                                                                                                                    throws com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException