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

Class DataCollectionTemplateService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.datacollection.rs2.template.DataCollectionTemplateService

@RestController("dataCollectionTemplateServiceOld")
@RequestMapping("datacollection/r2/templates")
@Resource(logging=true)
@Deprecated(forRemoval=true,
            since="22.0")
public class DataCollectionTemplateService
extends PrivateService

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

Services to manage data collection templates.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
DataCollectionTemplateService()	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>>	createRelease(Long id, @Valid DTODataCollectionTemplateReleaseInsert input)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new release.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	createSheet(Long id, @Valid DTODataCollectionTemplateInsertSheet input)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new sheet.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	createTemplate(@Valid DTODataCollectionTemplateCreate input)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new template.
org.springframework.http.ResponseEntity<DTODataCollectionTemplateHeader>	get(Long id, String language)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the required data collection template header.
org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionTemplateHeader>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTODataCollectionTemplateHeaderSearchFilter filter)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the all stored data collection template headers.
org.springframework.http.ResponseEntity<DTODataCollectionTemplateRelease>	getCurrentRelease(Long id)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the current release associated to the required template.
org.springframework.http.ResponseEntity<TreeModel<DTODataCollectionNode>>	getCurrentReleaseModel(Long id, String language)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the current release model associated to the required template.
org.springframework.http.ResponseEntity<DTODataCollectionTemplateRelease>	getRelease(Long id, Long releaseId)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the required release.
org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionTemplateRelease>>	getReleaseCollection(Long id, @NotNull @Valid Page page, @Valid @NotNull DTODataCollectionTemplateReleaseSearchFilter filter)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the required release collection.
org.springframework.http.ResponseEntity<TreeModel<DTODataCollectionNode>>	getReleaseModel(Long id, Long releaseId, String language)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the required release model.
org.springframework.http.ResponseEntity<DTODataCollectionTemplateWorkingCopy>	getWorkingCopy(Long id)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the working copy associated to the data collection template.
org.springframework.http.ResponseEntity<TreeModel<DTODataCollectionNode>>	getWorkingCopyModel(Long id, String language)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the required working copy model.
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTODataCollectionTemplateHeaderUpdate input)	Deprecated, for removal: This API element is subject to removal in a future version. Modify the required data collection template header.
org.springframework.http.ResponseEntity<Void>	patchRelease(Long id, Long releaseId, @Valid DTODataCollectionTemplateReleaseUpdate input)	Deprecated, for removal: This API element is subject to removal in a future version. Modify the required release.
org.springframework.http.ResponseEntity<Void>	patchWorkingCopy(Long id, @Valid DTODataCollectionTemplateWorkingCopyUpdate input)	Deprecated, for removal: This API element is subject to removal in a future version. Modify the required data collection template structure associated to the data collection template.
org.springframework.http.ResponseEntity<Void>	patchWorkingCopyModel(Long id, @Valid TreeModel<DTODataCollectionNode> input)	Deprecated, for removal: This API element is subject to removal in a future version. Modify the required working copy model.

Methods inherited from class java.lang.Object

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

Constructor Details

DataCollectionTemplateService

public DataCollectionTemplateService()

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<DTODataCollectionTemplateHeader>> getCollection(@RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTODataCollectionTemplateHeaderSearchFilter filter)
                                                                                                     throws DAException,
DAValidateException

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

Retrieve the all stored data collection template headers. DataCollectionTemplateHeaderSearchEvent

Parameters:

page - the required result page

filter - the specified DTODataCollectionTemplateHeaderSearchFilter

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<DTODataCollectionTemplateHeader> get(@PathVariable("id")
 Long id,
 @RequestParam(required=false,name="language",defaultValue="user")
 String language)
                                                                             throws DAException,
DAValidateException

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

Retrieve the required data collection template header. DataCollectionTemplateHeaderLoadEvent

Parameters:

id - data collection template header id

language - the language

Returns:

the data collection template header

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

patch

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

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

Modify the required data collection template header. DataCollectionTemplateHeaderUpdateEvent

Parameters:

id - the data collection template header update id

input - the data collection template header to update DTODataCollectionTemplateHeaderUpdate

Returns:

a standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getWorkingCopy

@GetMapping(value="{id:[0-9]+}/workingcopy",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTODataCollectionTemplateWorkingCopy> getWorkingCopy(@PathVariable("id")
 Long id)
                                                                                             throws DAException,
DAValidateException

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

Retrieve the working copy associated to the data collection template. DataCollectionTemplateLoadWorkingCopyEvent

Parameters:

id - the id

Returns:

the working copy

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

patchWorkingCopy

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

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

Modify the required data collection template structure associated to the data collection template. DataCollectionTemplateStructureUpdateEvent

Parameters:

id - the id

input - the DTODataCollectionTemplateWorkingCopyUpdate

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getWorkingCopyModel

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

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

Retrieve the required working copy model. DataCollectionTemplateLoadWorkingCopyEvent

Parameters:

id - the id

language - the language

Returns:

the working copy model

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

patchWorkingCopyModel

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

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

Modify the required working copy model. DataCollectionTemplateWorkingCopySaveEvent

Parameters:

id - the id

input - the TreeModel

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getReleaseCollection

@GetMapping(value="{id:[0-9]+}/releases",
            produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionTemplateRelease>> getReleaseCollection(@PathVariable("id")
 Long id,
 @RequestParam("page") @NotNull @Valid
 @NotNull @Valid Page page,
 @RequestParam("filter") @Valid @NotNull
 @Valid @NotNull DTODataCollectionTemplateReleaseSearchFilter filter)
                                                                                                             throws DAException,
DAValidateException

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

Retrieve the required release collection. DataCollectionTemplateStructureSearchEvent

Parameters:

id - the id

page - the page

filter - the DTODataCollectionTemplateReleaseSearchFilter

Returns:

the release collection

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getRelease

@GetMapping(value="{id:[0-9]+}/releases/{releaseId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTODataCollectionTemplateRelease> getRelease(@PathVariable("id")
 Long id,
 @PathVariable("releaseId")
 Long releaseId)
                                                                                     throws DAException,
DAValidateException

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

Retrieve the required release. DataCollectionTemplateStructureLoadEvent

Parameters:

id - the id

releaseId - the release id

Returns:

the release

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getReleaseModel

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

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

Retrieve the required release model. DataCollectionTemplateStructureLoadEvent

Parameters:

id - the id

releaseId - the release id

language - the language

Returns:

the release model

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getCurrentRelease

@GetMapping(value="{id:[0-9]+}/currentRelease",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTODataCollectionTemplateRelease> getCurrentRelease(@PathVariable("id")
 Long id)
                                                                                            throws DAException,
DAValidateException

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

Retrieve the current release associated to the required template. DataCollectionTemplateLoadCurrentReleaseEvent

Parameters:

id - the id

Returns:

the current release

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

getCurrentReleaseModel

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

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

Retrieve the current release model associated to the required template. DataCollectionTemplateLoadCurrentReleaseEvent

Parameters:

id - the id

language - the language

Returns:

the current release model

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

createTemplate

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

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

Create a new template. DataCollectionTemplateInsertEvent

Parameters:

input - the DTODataCollectionTemplateCreate

Returns:

the response

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

patchRelease

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

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

Modify the required release. DataCollectionTemplateStructureReleaseUpdateEvent

Parameters:

id - the id

releaseId - the release id

input - the input

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

createRelease

@PostMapping(value="{id:[0-9]+}/actions/createRelease",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> createRelease(@PathVariable("id")
 Long id,
 @Valid @RequestBody
 @Valid DTODataCollectionTemplateReleaseInsert input)
                                                                           throws DAException,
DAValidateException

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

Create a new release. DataCollectionTemplateInsertReleaseEvent

Parameters:

id - the id

input - the DTODataCollectionTemplateReleaseInsert

Returns:

the response

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

createSheet

@PostMapping(value="{id:[0-9]+}/actions/createSheet",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> createSheet(@PathVariable("id")
 Long id,
 @Valid @RequestBody
 @Valid DTODataCollectionTemplateInsertSheet input)
                                                                         throws DAException,
DAValidateException

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

Create a new sheet. DataCollectionTemplateInsertSheetEvent

Parameters:

id - the id

input - the DTODataCollectionTemplateInsertSheet

Returns:

the response

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception