Package io.dialob.questionnaire.service.rest

Class QuestionnairesRestServiceController

java.lang.Object

io.dialob.questionnaire.service.rest.QuestionnairesRestServiceController

All Implemented Interfaces:

QuestionnairesRestService

@RestController
public class QuestionnairesRestServiceController
extends Object
implements QuestionnairesRestService

Constructor Summary

Constructors

Constructor

Description

QuestionnairesRestServiceController(QuestionnaireSessionService questionnaireSessionService, QuestionnaireSessionSaveService questionnaireSessionSaveService, QuestionnaireSessionBuilderFactory questionnaireSessionBuilderFactory, QuestionnaireDatabase questionnaireRepository, FormDatabase formDatabase, CurrentTenant currentTenant, CurrentUserProvider currentUserProvider, CSVSerializer csvSerializer)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<io.dialob.api.rest.Response>	deleteQuestionnaire(String questionnaireId)
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>>	deleteQuestionnaireAnswer(String questionnaireId, String answerId)
org.springframework.http.ResponseEntity<List<String>>	deleteQuestionnaireItemRow(String questionnaireId, String itemId, String rowId)
org.springframework.http.ResponseEntity<String>	getCsv(Optional<String> formId, Optional<String> formName, Optional<String> formTag, Optional<List<String>> questionnaires, Optional<String> language, Optional<LocalDateTime> startDate, Optional<LocalDateTime> endDate)
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire>	getQuestionnaire(String questionnaireId)
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Answer>>	getQuestionnaireAnswers(String questionnaireId)
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>>	getQuestionnaireErrors(String questionnaireId)
org.springframework.http.ResponseEntity<io.dialob.api.proto.ActionItem>	getQuestionnaireItem(String questionnaireId, String itemId)
org.springframework.http.ResponseEntity<List<String>>	getQuestionnaireItemRows(String questionnaireId, String itemId)
org.springframework.http.ResponseEntity<List<io.dialob.api.proto.ActionItem>>	getQuestionnaireItems(String questionnaireId)
org.springframework.http.ResponseEntity<io.dialob.api.rest.Items>	getQuestionnairePages(String questionnaireId)
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.QuestionnaireListItem>>	getQuestionnaires(String owner, String formId, String formName, String formTag, io.dialob.api.questionnaire.Questionnaire.Metadata.Status status)
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire.Metadata.Status>	getQuestionnaireStatus(String questionnaireId)
org.springframework.http.ResponseEntity<io.dialob.api.proto.ValueSet>	getQuestionnaireValueSet(String questionnaireId, String valueSetId)
org.springframework.http.ResponseEntity<List<io.dialob.api.proto.ValueSet>>	getQuestionnaireValueSets(String questionnaireId)
protected <R> R	inSession(String questionnaireId, Function<QuestionnaireSession,R> operation)
org.springframework.http.ResponseEntity<io.dialob.api.rest.IdAndRevision>	postQuestionnaire(io.dialob.api.questionnaire.Questionnaire questionnaire)
org.springframework.http.ResponseEntity<List<String>>	postQuestionnaireItemRow(String questionnaireId, String itemId)
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire>	putQuestionnaire(String questionnaireId, io.dialob.api.questionnaire.Questionnaire questionnaire)
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>>	putQuestionnaireAnswer(String questionnaireId, String answerId, Object answer)	Updates answer
org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>>	putQuestionnaireAnswers(String questionnaireId, List<io.dialob.api.questionnaire.Answer> answers)
org.springframework.http.ResponseEntity<io.dialob.api.rest.Items>	putQuestionnairePages(String questionnaireId, io.dialob.api.rest.Items pages)
org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire.Metadata.Status>	putQuestionnaireStatus(String questionnaireId, io.dialob.api.questionnaire.Questionnaire.Metadata.Status status)
protected QuestionnaireSession	updateQuestionnaire(QuestionnaireSession questionnaireSession, Collection<io.dialob.api.proto.Action> actions)

Methods inherited from class java.lang.Object

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

Constructor Detail

QuestionnairesRestServiceController

public QuestionnairesRestServiceController(@NonNull
                                           QuestionnaireSessionService questionnaireSessionService,
                                           QuestionnaireSessionSaveService questionnaireSessionSaveService,
                                           @NonNull
                                           QuestionnaireSessionBuilderFactory questionnaireSessionBuilderFactory,
                                           @NonNull
                                           QuestionnaireDatabase questionnaireRepository,
                                           @NonNull
                                           FormDatabase formDatabase,
                                           @NonNull
                                           CurrentTenant currentTenant,
                                           @NonNull
                                           CurrentUserProvider currentUserProvider,
                                           @NonNull
                                           CSVSerializer csvSerializer)

Method Detail

postQuestionnaire

@PostMapping(produces="application/json",
             consumes="application/json")
public org.springframework.http.ResponseEntity<io.dialob.api.rest.IdAndRevision> postQuestionnaire(@NonNull @RequestBody @Validated
                                                                                                   io.dialob.api.questionnaire.Questionnaire questionnaire)

Specified by:

postQuestionnaire in interface QuestionnairesRestService

Parameters:

questionnaire -

Returns:

getQuestionnaires

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.QuestionnaireListItem>> getQuestionnaires(@RequestParam(name="owner",required=false)
                                                                                                                          String owner,
                                                                                                                          @RequestParam(name="formId",required=false)
                                                                                                                          String formId,
                                                                                                                          @RequestParam(name="formName",required=false)
                                                                                                                          String formName,
                                                                                                                          @RequestParam(name="formTag",required=false)
                                                                                                                          String formTag,
                                                                                                                          @RequestParam(name="status",required=false)
                                                                                                                          io.dialob.api.questionnaire.Questionnaire.Metadata.Status status)

Specified by:

getQuestionnaires in interface QuestionnairesRestService

Parameters:

owner -

formId -

formTag -

status -

Returns:

getQuestionnaire

@GetMapping(path="{questionnaireId}",
            produces="application/json")
public org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire> getQuestionnaire(@PathVariable("questionnaireId")
                                                                                                           String questionnaireId)

Specified by:

getQuestionnaire in interface QuestionnairesRestService

Parameters:

questionnaireId -

Returns:

deleteQuestionnaire

@DeleteMapping(path="{questionnaireId}",
               produces="application/json")
public org.springframework.http.ResponseEntity<io.dialob.api.rest.Response> deleteQuestionnaire(@PathVariable("questionnaireId")
                                                                                                String questionnaireId)

Specified by:

deleteQuestionnaire in interface QuestionnairesRestService

Parameters:

questionnaireId -

Returns:

putQuestionnaire

@PutMapping(path="{questionnaireId}",
            produces="application/json",
            consumes="application/json")
public org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire> putQuestionnaire(@PathVariable("questionnaireId")
                                                                                                           String questionnaireId,
                                                                                                           @RequestBody @Validated
                                                                                                           io.dialob.api.questionnaire.Questionnaire questionnaire)

Specified by:

putQuestionnaire in interface QuestionnairesRestService

Parameters:

questionnaireId -

questionnaire -

Returns:

getQuestionnaireStatus

@GetMapping(path="{questionnaireId}/status",
            produces="application/json")
public org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire.Metadata.Status> getQuestionnaireStatus(@PathVariable("questionnaireId")
                                                                                                                                 String questionnaireId)

Specified by:

getQuestionnaireStatus in interface QuestionnairesRestService

Parameters:

questionnaireId -

Returns:

putQuestionnaireStatus

@PutMapping(path="{questionnaireId}/status",
            produces="application/json",
            consumes="application/json")
public org.springframework.http.ResponseEntity<io.dialob.api.questionnaire.Questionnaire.Metadata.Status> putQuestionnaireStatus(@PathVariable("questionnaireId")
                                                                                                                                 String questionnaireId,
                                                                                                                                 @RequestBody
                                                                                                                                 io.dialob.api.questionnaire.Questionnaire.Metadata.Status status)

Specified by:

putQuestionnaireStatus in interface QuestionnairesRestService

Parameters:

questionnaireId -

status -

Returns:

getQuestionnaireAnswers

@GetMapping(path="{questionnaireId}/answers",
            produces="application/json")
public org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Answer>> getQuestionnaireAnswers(@PathVariable("questionnaireId")
                                                                                                                 String questionnaireId)

Specified by:

getQuestionnaireAnswers in interface QuestionnairesRestService

Parameters:

questionnaireId -

Returns:

getQuestionnaireErrors

@GetMapping(path="{questionnaireId}/errors",
            produces="application/json")
public org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>> getQuestionnaireErrors(@PathVariable("questionnaireId")
                                                                                                               String questionnaireId)

Specified by:

getQuestionnaireErrors in interface QuestionnairesRestService

Parameters:

questionnaireId -

Returns:

putQuestionnaireAnswers

@PostMapping(path="{questionnaireId}/answers",
             produces="application/json",
             consumes="application/json")
public org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>> putQuestionnaireAnswers(@PathVariable("questionnaireId")
                                                                                                                String questionnaireId,
                                                                                                                @RequestBody
                                                                                                                List<io.dialob.api.questionnaire.Answer> answers)

Specified by:

putQuestionnaireAnswers in interface QuestionnairesRestService

Parameters:

questionnaireId -

answers -

Returns:

putQuestionnaireAnswer

@PutMapping(path="{questionnaireId}/answers/{answerId}",
            produces="application/json",
            consumes="application/json")
public org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>> putQuestionnaireAnswer(@PathVariable("questionnaireId")
                                                                                                               String questionnaireId,
                                                                                                               @PathVariable("answerId")
                                                                                                               String answerId,
                                                                                                               @RequestBody
                                                                                                               Object answer)

Description copied from interface: QuestionnairesRestService

Updates answer

Specified by:

putQuestionnaireAnswer in interface QuestionnairesRestService

Parameters:

questionnaireId - target questionnaire id

answerId - answer id

answer - new answer value

Returns:

deleteQuestionnaireAnswer

@DeleteMapping(path="{questionnaireId}/answers/{answerId}",
               produces="application/json")
public org.springframework.http.ResponseEntity<List<io.dialob.api.questionnaire.Error>> deleteQuestionnaireAnswer(@PathVariable("questionnaireId")
                                                                                                                  String questionnaireId,
                                                                                                                  @PathVariable("answerId")
                                                                                                                  String answerId)

Specified by:

deleteQuestionnaireAnswer in interface QuestionnairesRestService

Parameters:

questionnaireId -

answerId -

Returns:

getQuestionnairePages

@GetMapping(path="{questionnaireId}/pages",
            produces="application/json")
public org.springframework.http.ResponseEntity<io.dialob.api.rest.Items> getQuestionnairePages(@PathVariable("questionnaireId")
                                                                                               String questionnaireId)

Specified by:

getQuestionnairePages in interface QuestionnairesRestService

Parameters:

questionnaireId -

Returns:

putQuestionnairePages

@PutMapping(path="{questionnaireId}/pages",
            produces="application/json")
public org.springframework.http.ResponseEntity<io.dialob.api.rest.Items> putQuestionnairePages(@NonNull @PathVariable("questionnaireId")
                                                                                               String questionnaireId,
                                                                                               @RequestBody
                                                                                               io.dialob.api.rest.Items pages)

Specified by:

putQuestionnairePages in interface QuestionnairesRestService

getQuestionnaireItems

@GetMapping(path="{questionnaireId}/items",
            produces="application/json")
public org.springframework.http.ResponseEntity<List<io.dialob.api.proto.ActionItem>> getQuestionnaireItems(@PathVariable("questionnaireId")
                                                                                                           String questionnaireId)

Specified by:

getQuestionnaireItems in interface QuestionnairesRestService

getQuestionnaireItem

@GetMapping(path="{questionnaireId}/items/{itemId}",
            produces="application/json")
public org.springframework.http.ResponseEntity<io.dialob.api.proto.ActionItem> getQuestionnaireItem(@PathVariable("questionnaireId")
                                                                                                    String questionnaireId,
                                                                                                    @PathVariable("itemId")
                                                                                                    String itemId)

Specified by:

getQuestionnaireItem in interface QuestionnairesRestService

getQuestionnaireItemRows

@GetMapping(path="{questionnaireId}/items/{itemId}/rows",
            produces="application/json")
public org.springframework.http.ResponseEntity<List<String>> getQuestionnaireItemRows(@PathVariable("questionnaireId")
                                                                                      String questionnaireId,
                                                                                      @PathVariable("itemId")
                                                                                      String itemId)

Specified by:

getQuestionnaireItemRows in interface QuestionnairesRestService

postQuestionnaireItemRow

@PostMapping(path="{questionnaireId}/items/{itemId}/rows",
             produces="application/json")
public org.springframework.http.ResponseEntity<List<String>> postQuestionnaireItemRow(@PathVariable("questionnaireId")
                                                                                      String questionnaireId,
                                                                                      @PathVariable("itemId")
                                                                                      String itemId)

Specified by:

postQuestionnaireItemRow in interface QuestionnairesRestService

deleteQuestionnaireItemRow

@DeleteMapping(path="{questionnaireId}/items/{itemId}/rows/{rowId}",
               produces="application/json")
public org.springframework.http.ResponseEntity<List<String>> deleteQuestionnaireItemRow(@PathVariable("questionnaireId")
                                                                                        String questionnaireId,
                                                                                        @PathVariable("itemId")
                                                                                        String itemId,
                                                                                        @PathVariable("rowId")
                                                                                        String rowId)

Specified by:

deleteQuestionnaireItemRow in interface QuestionnairesRestService

getQuestionnaireValueSets

@GetMapping(path="{questionnaireId}/valueSets",
            produces="application/json")
public org.springframework.http.ResponseEntity<List<io.dialob.api.proto.ValueSet>> getQuestionnaireValueSets(@PathVariable("questionnaireId")
                                                                                                             String questionnaireId)

Specified by:

getQuestionnaireValueSets in interface QuestionnairesRestService

getQuestionnaireValueSet

@GetMapping(path="{questionnaireId}/valueSets/{valueSetId}",
            produces="application/json")
public org.springframework.http.ResponseEntity<io.dialob.api.proto.ValueSet> getQuestionnaireValueSet(@PathVariable("questionnaireId")
                                                                                                      String questionnaireId,
                                                                                                      @PathVariable("valueSetId")
                                                                                                      String valueSetId)

Specified by:

getQuestionnaireValueSet in interface QuestionnairesRestService

updateQuestionnaire

protected QuestionnaireSession updateQuestionnaire(QuestionnaireSession questionnaireSession,
                                                   Collection<io.dialob.api.proto.Action> actions)

inSession

protected <R> R inSession(String questionnaireId,
                          Function<QuestionnaireSession,R> operation)

getCsv

public org.springframework.http.ResponseEntity<String> getCsv(Optional<String> formId,
                                                              Optional<String> formName,
                                                              Optional<String> formTag,
                                                              Optional<List<String>> questionnaires,
                                                              Optional<String> language,
                                                              Optional<LocalDateTime> startDate,
                                                              Optional<LocalDateTime> endDate)

Specified by:

getCsv in interface QuestionnairesRestService