Package overit.geocallapp.wfm.core.datacollection.rs2.optionsgroup

Class DataCollectionOptionsGroupService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.datacollection.rs2.optionsgroup.DataCollectionOptionsGroupService

@RestController("dataCollectionOptionsGroupServiceOld")
@RequestMapping("datacollection/r2/optionsGroup")
@Resource(logging=true)
@Deprecated(forRemoval=true,
            since="22.0")
public class DataCollectionOptionsGroupService
extends PrivateService

Deprecated, for removal: This API element is subject to removal in a future version.

Services to manage data collection option groups.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
DataCollectionOptionsGroupService()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	createOptionsGroup(@Valid DTODataCollectionOptionsGroup input)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new options group.
org.springframework.http.ResponseEntity<DTODataCollectionOptionsGroup>	get(Long id, String language)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the required data collection options group.
org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionOptionsGroup>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTODataCollectionOptionsGroupSearchFilter filter)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the all stored data collection option groups.
List<DTODataCollectionNodeSelectionOption>	getModel(Long id, String language)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the required model.
org.springframework.http.ResponseEntity<Void>	patchOperationsGroupModel(Long id, @Valid List<DataCollectionNodeSelectionOption> input)	Deprecated, for removal: This API element is subject to removal in a future version. Modify the required data collection options group model.
org.springframework.http.ResponseEntity<Void>	patchOptionsGroup(Long id, @Valid DTODataCollectionOptionsGroup input)	Deprecated, for removal: This API element is subject to removal in a future version. Modify the required data collection options group.

Methods inherited from class java.lang.Object

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

Constructor Details

DataCollectionOptionsGroupService

public DataCollectionOptionsGroupService()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionOptionsGroup>> getCollection(@RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTODataCollectionOptionsGroupSearchFilter filter)
                                                                                                   throws DAException,
DAValidateException

Deprecated, for removal: This API element is subject to removal in a future version.

Retrieve the all stored data collection option groups. DataCollectionOptionsGroupSearchEvent

Parameters:

page - the required result page

filter - the specified DTODataCollectionOptionsGroupSearchFilter

Returns:

the current result page

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

get

@GetMapping(value="{id:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTODataCollectionOptionsGroup> get(@PathVariable("id")
 Long id,
 @RequestParam(required=false,name="language",defaultValue="user")
 String language)
                                                                           throws DAValidateException,
DAException

Deprecated, for removal: This API element is subject to removal in a future version.

Retrieve the required data collection options group. DataCollectionOptionsGroupLoadEvent

Parameters:

id - data collection sheet id

language - the language

Returns:

the data collection options group

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getModel

@GetMapping(value="{id:[0-9]+}/model",
            produces="application/json")
public List<DTODataCollectionNodeSelectionOption> getModel(@PathVariable("id")
 Long id,
 @RequestParam(required=false,name="language",defaultValue="user")
 String language)
                                                    throws DAValidateException,
DAException

Deprecated, for removal: This API element is subject to removal in a future version.

Retrieve the required model. DataCollectionOptionsGroupLoadEvent

Parameters:

id - the id

language - the language

Returns:

the model

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

See Also:

• DTODataCollectionNodeSelectionOption

createOptionsGroup

@PostMapping(value="/actions/createOptionsGroup",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> createOptionsGroup(@Valid @RequestBody
 @Valid DTODataCollectionOptionsGroup input)
                                                                                throws DAException,
DAValidateException

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new options group. DataCollectionOptionsGroupInsertEvent

Parameters:

input - the DTODataCollectionOptionsGroup

Returns:

the response

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

patchOptionsGroup

@PatchMapping(value="{id:[0-9]+}/optionsGroup",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patchOptionsGroup(@PathVariable("id")
 Long id,
 @Valid @RequestBody
 @Valid DTODataCollectionOptionsGroup input)
                                                                throws DAValidateException,
DAException

Deprecated, for removal: This API element is subject to removal in a future version.

Modify the required data collection options group. DataCollectionOptionsGroupUpdateEvent

Parameters:

id - the id

input - the DTODataCollectionOptionsGroup

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patchOperationsGroupModel

@PatchMapping(value="{id:[0-9]+}/optionsGroup/model",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patchOperationsGroupModel(@PathVariable("id")
 Long id,
 @Valid @RequestBody
 @Valid List<DataCollectionNodeSelectionOption> input)
                                                                        throws DAValidateException,
DAException

Deprecated, for removal: This API element is subject to removal in a future version.

Modify the required data collection options group model. DataCollectionOptionsGroupUpdateEvent

Parameters:

id - the id

input - the list of DataCollectionNodeSelectionOption

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception