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

Class DataCollectionSheetService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.core.datacollection.rs2.sheet.DataCollectionSheetService

@RestController("dataCollectionSheetServiceOld")
@RequestMapping("datacollection/r2/sheets")
@Resource(logging=true)
@Deprecated(forRemoval=true,
            since="22.0")
public class DataCollectionSheetService
extends PrivateService

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

Services to manage data collection sheets.

Since:

19.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
DataCollectionSheetService()	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<Void>	associateToSchedulingResource(Long id, @Valid DTODataCollectionSheetAssociateSchedulingResource resourceInput)	Deprecated, for removal: This API element is subject to removal in a future version. Associate to scheduling resource.
org.springframework.http.ResponseEntity<Void>	associateToWOOperation(Long id, @Valid DTODataCollectionSheetAssociateWOOperation woOperationInput)	Deprecated, for removal: This API element is subject to removal in a future version. Associate sheet to the specified WO Operation.
org.springframework.http.ResponseEntity<Void>	cancelSheet(Long id)	Deprecated, for removal: This API element is subject to removal in a future version. Cancel the required sheet.
org.springframework.http.ResponseEntity<Void>	closeSchedulingResourceSheet(Long id)	Deprecated, for removal: This API element is subject to removal in a future version. Close a sheet assigned to a scheduling resource.
org.springframework.http.ResponseEntity<Void>	dissociateFromSchedulingResource(Long id)	Deprecated, for removal: This API element is subject to removal in a future version. Dissociate from scheduling resource.
org.springframework.http.ResponseEntity<Void>	dissociateFromWOOperation(Long id)	Deprecated, for removal: This API element is subject to removal in a future version. Dissociate sheet from WO Operation DataCollectionSheetInstanceDissociateFromWOOperationEvent
org.springframework.http.ResponseEntity<Void>	fixSchedulingResourceSheet(Long id)	Deprecated, for removal: This API element is subject to removal in a future version. Fix a sheet assigned to a scheduling resource.
org.springframework.http.ResponseEntity<DTODataCollectionSheet>	get(Long id, String language)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the required data collection sheet.
org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionSheet>>	getCollection(@NotNull @Valid Page page, @Valid @NotNull DTODataCollectionSheetSearchFilter filter)	Deprecated, for removal: This API element is subject to removal in a future version. Retrieve the all stored data collection sheets.
TreeModel<DTODataCollectionNode>	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>	post(Long id, List<DTODataCollectionNodeFillIn> fillInNodes)	Deprecated, for removal: This API element is subject to removal in a future version. Fill-in the specified nodes with given values.

Methods inherited from class java.lang.Object

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

Constructor Details

DataCollectionSheetService

public DataCollectionSheetService()

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

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

Retrieve the all stored data collection sheets. DataCollectionSheetSearchExtendedEvent

Parameters:

page - the required result page

filter - the specified DTODataCollectionSheetSearchFilter

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<DTODataCollectionSheet> 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 sheet. DataCollectionSheetLoadEvent

Parameters:

id - data collection sheet id

language - the language

Returns:

the data collection sheet

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(value="{id:[0-9]+}/actions/fillIn",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> post(@PathVariable("id")
 Long id,
 @RequestBody
 List<DTODataCollectionNodeFillIn> fillInNodes)
                                                   throws DAException,
DAValidateException,
com.fasterxml.jackson.core.JsonProcessingException

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

Fill-in the specified nodes with given values. DataCollectionSheetInstanceFillInEvent

Parameters:

id - the id

fillInNodes - list of DTODataCollectionNodeFillIn elements

Returns:

the response

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

com.fasterxml.jackson.core.JsonProcessingException - the json processing exception

getModel

@GetMapping(value="{id:[0-9]+}/model",
            produces="application/json")
public TreeModel<DTODataCollectionNode> 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. DataCollectionSheetLoadEvent

Parameters:

id - the id

language - the language

Returns:

the model

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

associateToWOOperation

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

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

Associate sheet to the specified WO Operation. DataCollectionSheetInstanceAssociateToWOOperationEvent

Parameters:

id - the id

woOperationInput - the DTODataCollectionSheetAssociateWOOperation

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

dissociateFromWOOperation

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

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

Dissociate sheet from WO Operation DataCollectionSheetInstanceDissociateFromWOOperationEvent

Parameters:

id - the id

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

associateToSchedulingResource

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

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

Associate to scheduling resource. DataCollectionSheetInstanceAssociateToSchedulingUserEvent

Parameters:

id - the id

resourceInput - the DTODataCollectionSheetAssociateSchedulingResource

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

dissociateFromSchedulingResource

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

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

Dissociate from scheduling resource. DataCollectionSheetInstanceDissociateFromSchedulingUserEvent

Parameters:

id - the id

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

fixSchedulingResourceSheet

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

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

Fix a sheet assigned to a scheduling resource. DataCollectionSheetInstanceFixSchedulingResourceSheetEvent

Parameters:

id - the id

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

closeSchedulingResourceSheet

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

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

Close a sheet assigned to a scheduling resource. DataCollectionSheetInstanceCloseSchedulingResourceSheetEvent

Parameters:

id - the id

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

cancelSheet

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

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

Cancel the required sheet. DataCollectionSheetInstanceCancelEvent

Parameters:

id - the id

Returns:

the response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception