Package overit.geocallapp.wfm.projects.rs1.calendarunit

Class CalendarUnitService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.projects.rs1.calendarunit.CalendarUnitService

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

Services to manage calendar unit

Since:

16.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
CalendarUnitService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOCalendarUnit>	get(Long id, String language, Collection<String> fields)	Retrieves the required calendar unit by calling the CalendarUnitLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOCalendarUnit>>	getCollection(@Valid Page page, String language, Collection<String> fields, String order, @Valid DTOCalendarUnitFilter filter)	Returns the collection of all the calendar unit by calling the CalendarUnitSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

CalendarUnitService

public CalendarUnitService()

Method Details

get

@GetMapping(value="{calendarUnitId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOCalendarUnit> get(@PathVariable("calendarUnitId")
 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 calendar unit by calling the CalendarUnitLoadEvent.

Parameters:

id - calendar unit id

language - the user language

fields - the collection of fields the response will contain

Returns:

the ResponseEntity containing the loaded DTOCalendarUnit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

getCollection

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

Returns the collection of all the calendar unit by calling the CalendarUnitSearchEvent.

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 DTOCalendarUnitFilter

Returns:

the ResponseEntity containing the collection of DTOCalendarUnit

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception