Package overit.geocallapp.wfm.datacollection.rs1.sheet.state

Class DataCollectionSheetStateService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.datacollection.rs1.sheet.state.DataCollectionSheetStateService

@RestController
@RequestMapping("documents/dynamic-forms/r1/sheet-status")
@Resource(logging=true)
public class DataCollectionSheetStateService
extends PrivateService

Service for manage sheet state

Since:

22.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
DataCollectionSheetStateService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTODataCollectionSheetState>	get(Long sheetStatusId, String language, Collection<String> fields)	Retrieves a specific data collection sheet state by its identifier.
org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionSheetState>>	getCollection(@Valid Page page, Collection<String> fields, String order, String language, @Valid @NotNull DTODataCollectionSheetStateFilter filter)	Retrieves a paginated collection of data collection sheet states based on the provided search criteria.

Methods inherited from class java.lang.Object

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

Constructor Details

DataCollectionSheetStateService

public DataCollectionSheetStateService()

Method Details

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionSheetState>> 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 DTODataCollectionSheetStateFilter filter)
                                                                                                 throws DAValidateException,
DAException

Retrieves a paginated collection of data collection sheet states based on the provided search criteria.

Parameters:

page - the pagination parameters (page number, page size)

fields - optional collection of field names to include in the response (for partial representation)

order - optional ordering specification for sorting the results

language - the language code for localized strings (defaults to user's language)

filter - the search filter criteria for data collection sheet states

Returns:

a ResponseEntity containing a PageResponse with the collection of DTODataCollectionSheetState

Throws:

DAValidateException - if validation fails

DAException - if a data access error occurs

get

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

Retrieves a specific data collection sheet state by its identifier.

Parameters:

sheetStatusId - the unique identifier of the sheet state to retrieve

language - the language code for localized strings (defaults to user's language)

fields - optional collection of field names to include in the response (for partial representation)

Returns:

a ResponseEntity containing the DTODataCollectionSheetState

Throws:

DAValidateException - if validation fails or the sheet state is not found

DAException - if a data access error occurs