Class DataCollectionOptionsGroupService
java.lang.Object
overit.geocallapp.utilities.rs.common.PrivateService
overit.geocallapp.wfm.datacollection.rs1.optionsgroup.DataCollectionOptionsGroupService
@RestController
@RequestMapping("documents/dynamic-forms/r1/option-groups")
@Resource(logging=true)
public class DataCollectionOptionsGroupService
extends PrivateService
Service for manage options group
- Since:
- 22.0
- GCApi:
- rest
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<Void> Delete the required data collection options group.org.springframework.http.ResponseEntity<DTODataCollectionOptionsGroup> get(Long optionGroupId, String language, Collection<String> fields) Retrieve the required data collection options group.org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionOptionsGroup>> getCollection(@Valid Page page, Collection<String> fields, String order, String language, @Valid @NotNull DTODataCollectionOptionsGroupFilter filter) Retrieve the all stored data collection option groups.org.springframework.http.ResponseEntity<List<DTODataCollectionNodeSelectionOption>> Retrieve the required model.org.springframework.http.ResponseEntity<Void> patch(Long optionGroupId, @Valid DTODataCollectionOptionsGroupUpdate input) Modify the required data collection options group.org.springframework.http.ResponseEntity<Void> patchModel(Long optionGroupId, @Valid List<DTODataCollectionNodeSelectionOption> input) Modify the required data collection options group model.org.springframework.http.ResponseEntity<DTOIdentifier<Long>> Create a new options group.
-
Constructor Details
-
DataCollectionOptionsGroupService
public DataCollectionOptionsGroupService()
-
-
Method Details
-
getCollection
@GetMapping(produces="application/json") public org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionOptionsGroup>> getCollection(@RequestParam("_page") @Valid @Valid Page page, @RequestParam(required=false,name="_fields") Collection<String> fields, @RequestParam(required=false,name="_order") String order, @RequestParam(required=false,name="_language",defaultValue="user") String language, @Valid @NotNull @Valid @NotNull DTODataCollectionOptionsGroupFilter filter) throws DAValidateException, DAException Retrieve the all stored data collection option groups.DataCollectionOptionsGroupSearchEvent- Parameters:
page- the required result pagefilter- the specifiedDTODataCollectionOptionsGroupFilter- Returns:
- the current result page
- Throws:
DAException- the DA exceptionDAValidateException- the DA validate exception
-
get
@GetMapping(value="{optionGroupId:[0-9]+}", produces="application/json") public org.springframework.http.ResponseEntity<DTODataCollectionOptionsGroup> get(@PathVariable("optionGroupId") Long optionGroupId, @RequestParam(required=false,name="_language",defaultValue="user") String language, @RequestParam(required=false,value="_fields") Collection<String> fields) throws DAValidateException, DAException Retrieve the required data collection options group.DataCollectionOptionsGroupLoadEvent- Parameters:
optionGroupId- data collection options group idlanguage- the language- Returns:
- the data collection options group
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
post
@PostMapping(consumes="application/json", produces="application/json") public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid @RequestBody @Valid DTODataCollectionOptionsGroupInsert input) throws DAValidateException, DAException Create a new options group.DataCollectionOptionsGroupInsertEvent- Parameters:
input- theDTODataCollectionOptionsGroup- Returns:
- the response
- Throws:
DAException- the DA exceptionDAValidateException- the DA validate exception
-
patch
@PatchMapping(value="{optionGroupId:[0-9]+}", consumes="application/json", produces="application/json") public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("optionGroupId") Long optionGroupId, @Valid @RequestBody @Valid DTODataCollectionOptionsGroupUpdate input) throws DAValidateException, DAException Modify the required data collection options group.DataCollectionOptionsGroupUpdateEvent- Parameters:
optionGroupId- the idinput- theDTODataCollectionOptionsGroup- Returns:
- the response
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
delete
@DeleteMapping(value="{optionGroupId:[0-9]+}", produces="application/json") public org.springframework.http.ResponseEntity<Void> delete(@PathVariable("optionGroupId") Long optionGroupId) throws DAValidateException, DAException Delete the required data collection options group.DataCollectionOptionsGroupLoadEvent- Parameters:
optionGroupId- data collection sheet id- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-
getModel
@GetMapping(value="{optionGroupId:[0-9]+}/models", produces="application/json") public org.springframework.http.ResponseEntity<List<DTODataCollectionNodeSelectionOption>> getModel(@PathVariable("optionGroupId") Long optionGroupId, @RequestParam(required=false,name="_language",defaultValue="user") String language) throws DAValidateException, DAException Retrieve the required model.DataCollectionOptionsGroupLoadEvent- Parameters:
optionGroupId- the idlanguage- the language- Returns:
- the model
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception- See Also:
-
patchModel
@PatchMapping(value="{optionGroupId:[0-9]+}/models", consumes="application/json", produces="application/json") public org.springframework.http.ResponseEntity<Void> patchModel(@PathVariable("optionGroupId") Long optionGroupId, @Valid @RequestBody @Valid List<DTODataCollectionNodeSelectionOption> input) throws DAValidateException, DAException Modify the required data collection options group model.DataCollectionOptionsGroupUpdateEvent- Parameters:
optionGroupId- the idinput- the list ofDataCollectionNodeSelectionOption- Returns:
- the response
- Throws:
DAValidateException- the DA validate exceptionDAException- the DA exception
-