Package overit.geocallapp.wfm.projects.rs1.timerangeconfiguration

Class TimeRangeConfigurationService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.projects.rs1.timerangeconfiguration.TimeRangeConfigurationService

@RestController
@RequestMapping("work-orders/projects/r1/calendars")
@Resource(logging=true)
public class TimeRangeConfigurationService
extends PrivateService

Services to manage calendar

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
TimeRangeConfigurationService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOTimeRangeConfiguration>	get(Long id, String language, Collection<String> fields)	Retrieves the required time range configuration by calling the TimeRangeConfigurationLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOTimeRangeConfiguration>>	getCollection(@Valid Page page, String language, Collection<String> fields, String order, @Valid DTOTimeRangeConfigurationFilter filter)	Returns the collection of all the calendar by calling the TimeRangeConfigurationSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

TimeRangeConfigurationService

public TimeRangeConfigurationService()

Method Details

get

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

Retrieves the required time range configuration by calling the TimeRangeConfigurationLoadEvent.

Parameters:

id - time range configuration id

language - the user language

fields - the collection of fields the response will contain

Returns:

the ResponseEntity containing the loaded DTOTimeRangeConfiguration

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

@GetMapping(produces="application/json")
public org.springframework.http.ResponseEntity<PageResponse<DTOTimeRangeConfiguration>> getCollection(@RequestParam("_page") @Valid
 @Valid Page page,
 @RequestParam(required=false,name="_language",defaultValue="user")
 String language,
 @RequestParam(required=false,value="_fields")
 Collection<String> fields,
 @RequestParam(required=false,value="_order")
 String order,
 @Valid
 @Valid DTOTimeRangeConfigurationFilter filter)
                                                                                               throws DAValidateException,
DAException

Returns the collection of all the calendar by calling the TimeRangeConfigurationSearchEvent.

Parameters:

page - the Page that will contain the paginated result

language - the user language

fields - the collection of fields the response will contain

order - the ordering field

filter - the DTOTimeRangeConfigurationFilter

Returns:

the ResponseEntity containing the collection of DTOTimeRangeConfiguration

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception