Package overit.geocallapp.wfm.datacollection.rs1.scope

Class DataCollectionScopeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.datacollection.rs1.scope.DataCollectionScopeService

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

Service for manage data collection scope

Since:

22.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
DataCollectionScopeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTODataCollectionScope>	get(Long scopeId, String language, Collection<String> fields)	Retrieves a specific data collection scope by its identifier.
org.springframework.http.ResponseEntity<PageResponse<DTODataCollectionScope>>	getCollection(@Valid Page page, Collection<String> fields, String order, String language, @Valid @NotNull DTODataCollectionScopeFilter filter)	Retrieves a paginated collection of data collection scopes 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

DataCollectionScopeService

public DataCollectionScopeService()

Method Details

getCollection

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

Retrieves a paginated collection of data collection scopes 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 scopes

Returns:

a ResponseEntity containing a PageResponse with the collection of DTODataCollectionScope

Throws:

DAValidateException - if validation fails

DAException - if a data access error occurs

get

@GetMapping(value="{scopeId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTODataCollectionScope> get(@PathVariable("scopeId")
 Long scopeId,
 @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 scope by its identifier.

Parameters:

scopeId - the unique identifier of the data collection scope 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 DTODataCollectionScope

Throws:

DAValidateException - if validation fails or the data collection scope is not found

DAException - if a data access error occurs