com.clusterra.pmbok.rest.document

Class DocumentController

java.lang.Object

com.clusterra.pmbok.rest.document.DocumentController

@RestController
 @ExposesResourceFor(value=com.clusterra.pmbok.document.domain.model.document.Document.class)
 @RequestMapping(value="pmbok/documents",
                produces="application/json")
public class DocumentController
extends java.lang.Object

Created by dkuchugurov on 26.02.14.

Constructor Summary

Constructors

Constructor and Description
DocumentController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<DocumentResource>	approve(java.lang.String id, CommentPod commentPod)
org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable>	associateReference(java.lang.String id, java.lang.String referenceId)
org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable>	associateTerm(java.lang.String id, java.lang.String termId)
org.springframework.http.ResponseEntity<DocumentResource>	create(DocumentPod documentPod, org.springframework.validation.BindingResult bindingResult)
org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable>	delete(java.lang.String id)
org.springframework.http.ResponseEntity<DocumentResource>	edit(java.lang.String id, CommentPod commentPod)
org.springframework.http.ResponseEntity<DocumentResource>	get(java.lang.String id)
org.springframework.http.ResponseEntity<DocumentResource>	publish(java.lang.String id, CommentPod commentPod)
org.springframework.http.ResponseEntity<org.springframework.hateoas.PagedResources<DocumentResource>>	search(org.springframework.data.domain.Pageable pageable, java.lang.String projectId, java.lang.String projectVersionId, java.lang.String searchBy, org.springframework.data.web.PagedResourcesAssembler<com.clusterra.pmbok.document.domain.model.document.Document> assembler)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<SectionResource>>	sections(java.lang.String id)
org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable>	unAssociateReference(java.lang.String id, java.lang.String referenceId)
org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable>	unAssociateTerm(java.lang.String id, java.lang.String termId)
org.springframework.http.ResponseEntity<SectionResource>	updateText(java.lang.String id, java.lang.String sectionTemplateId, TextPod textPod)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentController

public DocumentController()

Method Detail

create

@RequestMapping(value="",
                method=POST)
public org.springframework.http.ResponseEntity<DocumentResource> create(@RequestBody
                                                                                                                               DocumentPod documentPod,
                                                                                                                               org.springframework.validation.BindingResult bindingResult)
                                                                                                                        throws org.springframework.validation.BindException,
                                                                                                                               com.clusterra.pmbok.project.domain.service.ProjectNotFoundException,
                                                                                                                               com.clusterra.pmbok.document.domain.service.document.DocumentAlreadyExistsException,
                                                                                                                               com.clusterra.pmbok.project.domain.service.ProjectVersionNotFoundException,
                                                                                                                               com.clusterra.iam.core.application.tracker.NotAuthenticatedException,
                                                                                                                               com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException

Throws:

org.springframework.validation.BindException

com.clusterra.pmbok.project.domain.service.ProjectNotFoundException

com.clusterra.pmbok.document.domain.service.document.DocumentAlreadyExistsException

com.clusterra.pmbok.project.domain.service.ProjectVersionNotFoundException

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

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

get

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

Throws:

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

com.clusterra.pmbok.document.domain.service.document.DocumentNotEditableException

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.document.DocumentNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

publish

@RequestMapping(value="/{id}/publish",
                method=PUT)
public org.springframework.http.ResponseEntity<DocumentResource> publish(@PathVariable
                                                                                                                                            java.lang.String id,
                                                                                                                                            @RequestBody
                                                                                                                                            CommentPod commentPod)
                                                                                                                                     throws com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException,
                                                                                                                                            com.clusterra.pmbok.document.domain.service.document.DocumentNotEditableException

Throws:

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

com.clusterra.pmbok.document.domain.service.document.DocumentNotEditableException

approve

@RequestMapping(value="/{id}/approve",
                method=PUT)
public org.springframework.http.ResponseEntity<DocumentResource> approve(@PathVariable
                                                                                                                                            java.lang.String id,
                                                                                                                                            @RequestBody
                                                                                                                                            CommentPod commentPod)
                                                                                                                                     throws com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException,
                                                                                                                                            com.clusterra.pmbok.document.domain.service.document.DocumentNotEditableException

Throws:

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

com.clusterra.pmbok.document.domain.service.document.DocumentNotEditableException

edit

@RequestMapping(value="/{id}/edit",
                method=PUT)
public org.springframework.http.ResponseEntity<DocumentResource> edit(@PathVariable
                                                                                                                                      java.lang.String id,
                                                                                                                                      @RequestBody
                                                                                                                                      CommentPod commentPod)
                                                                                                                               throws com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException,
                                                                                                                                      com.clusterra.pmbok.document.domain.service.document.DocumentNotEditableException

Throws:

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

com.clusterra.pmbok.document.domain.service.document.DocumentNotEditableException

search

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

Throws:

com.clusterra.pmbok.project.domain.service.ProjectVersionNotFoundException

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

com.clusterra.pmbok.project.domain.service.ProjectNotFoundException

sections

@RequestMapping(value="/{id}/sections",
                method=GET)
public org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<SectionResource>> sections(@PathVariable
                                                                                                                                                                                    java.lang.String id)
                                                                                                                                                                             throws com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException,
                                                                                                                                                                                    com.clusterra.pmbok.document.domain.service.template.TemplateNotFoundException,
                                                                                                                                                                                    com.clusterra.iam.core.application.tracker.NotAuthenticatedException

Throws:

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

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

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

associateTerm

@RequestMapping(value="/{id}/terms/{termId}",
                method=POST)
public org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable> associateTerm(@PathVariable
                                                                                                                                                                                                            java.lang.String id,
                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                            java.lang.String termId)
                                                                                                                                                                                                     throws com.clusterra.pmbok.term.domain.service.TermNotFoundException,
                                                                                                                                                                                                            com.clusterra.iam.core.application.tracker.NotAuthenticatedException,
                                                                                                                                                                                                            com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException,
                                                                                                                                                                                                            com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

Throws:

com.clusterra.pmbok.term.domain.service.TermNotFoundException

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

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

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

unAssociateTerm

@RequestMapping(value="/{id}/terms/{termId}",
                method=DELETE)
public org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable> unAssociateTerm(@PathVariable
                                                                                                                                                                                                                java.lang.String id,
                                                                                                                                                                                                                @PathVariable
                                                                                                                                                                                                                java.lang.String termId)
                                                                                                                                                                                                         throws com.clusterra.pmbok.term.domain.service.TermNotFoundException,
                                                                                                                                                                                                                com.clusterra.iam.core.application.tracker.NotAuthenticatedException,
                                                                                                                                                                                                                com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException,
                                                                                                                                                                                                                com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

Throws:

com.clusterra.pmbok.term.domain.service.TermNotFoundException

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

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

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

associateReference

@RequestMapping(value="/{id}/references/{referenceId}",
                method=POST)
public org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable> associateReference(@PathVariable
                                                                                                                                                                                                                           java.lang.String id,
                                                                                                                                                                                                                           @PathVariable
                                                                                                                                                                                                                           java.lang.String referenceId)
                                                                                                                                                                                                                    throws com.clusterra.pmbok.reference.domain.service.ReferenceNotFoundException,
                                                                                                                                                                                                                           com.clusterra.iam.core.application.tracker.NotAuthenticatedException,
                                                                                                                                                                                                                           com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException,
                                                                                                                                                                                                                           com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

Throws:

com.clusterra.pmbok.reference.domain.service.ReferenceNotFoundException

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

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

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

unAssociateReference

@RequestMapping(value="/{id}/references/{referenceId}",
                method=DELETE)
public org.springframework.http.ResponseEntity<org.springframework.context.support.DefaultMessageSourceResolvable> unAssociateReference(@PathVariable
                                                                                                                                                                                                                               java.lang.String id,
                                                                                                                                                                                                                               @PathVariable
                                                                                                                                                                                                                               java.lang.String referenceId)
                                                                                                                                                                                                                        throws com.clusterra.pmbok.reference.domain.service.ReferenceNotFoundException,
                                                                                                                                                                                                                               com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException,
                                                                                                                                                                                                                               com.clusterra.iam.core.application.tracker.NotAuthenticatedException,
                                                                                                                                                                                                                               com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

Throws:

com.clusterra.pmbok.reference.domain.service.ReferenceNotFoundException

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

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

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

updateText

@RequestMapping(value="/{id}/sections/{sectionTemplateId}/update-text",
                method=POST)
public org.springframework.http.ResponseEntity<SectionResource> updateText(@PathVariable
                                                                                                                                                                                java.lang.String id,
                                                                                                                                                                                @PathVariable
                                                                                                                                                                                java.lang.String sectionTemplateId,
                                                                                                                                                                                @RequestBody
                                                                                                                                                                                TextPod textPod)
                                                                                                                                                                         throws com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException,
                                                                                                                                                                                com.clusterra.pmbok.document.domain.model.template.SectionTemplateNotFoundException

Throws:

com.clusterra.pmbok.document.domain.service.document.DocumentNotFoundException

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