Package overit.geocallapp.wfm.execution.rs1.hourtype

Class HourTypeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.execution.rs1.hourtype.HourTypeService

@RestController
@RequestMapping("work-orders/execution/r1/working-hours-types")
@Resource(logging=true)
public class HourTypeService
extends PrivateService

Service to manage hour types.

Since:

18.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
HourTypeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOHourType>	get(Long hourTypeId, Collection<String> fields)	Retrieves the required hour type by calling from the HourTypeLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOHourType>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid @NotNull DTOHourTypeFilter filter)	Returns the collection of all the stored hour types by calling the HourTypeSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

HourTypeService

public HourTypeService()

Method Details

getCollection

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

Returns the collection of all the stored hour types by calling the HourTypeSearchEvent.

Parameters:

page - the Page that will contain the paginated result

fields - the collection of fields that will be contained in the response

order - the ordering field

filter - the DTOHourTypeFilter

Returns:

the collection of hour types

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required hour type by calling from the HourTypeLoadEvent.

Parameters:

hourTypeId - the hour type Id

fields - the collection of fields that will be contained in the response

Returns:

the response containing the loaded hour type

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception