Package overit.geocallapp.wfm.calendars.rs1.availabilitytypes

Class AvailabilityTypeService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.calendars.rs1.availabilitytypes.AvailabilityTypeService

@RestController
@RequestMapping("workforce/calendars/r1/availability-types")
@Resource(logging=true)
public class AvailabilityTypeService
extends PrivateService

Service to manage availability types.

Since:

17.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
AvailabilityTypeService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOAvailabilityType>	get(Long id, Collection<String> fields)	Retrieves the required availability type by calling the AvailabilityTypeLoadEvent.
org.springframework.http.ResponseEntity<PageResponse<DTOAvailabilityType>>	getCollection(@Valid Page page, Collection<String> fields, String order, @Valid DTOAvailabilityTypeFilter filter)	Returns the collection of all the stored availability types by calling the AvailabilityTypeSearchEvent.

Methods inherited from class java.lang.Object

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

Constructor Details

AvailabilityTypeService

public AvailabilityTypeService()

Method Details

getCollection

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

Returns the collection of all the stored availability types by calling the AvailabilityTypeSearchEvent.

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 DTOAvailabilityTypeFilter

Returns:

the collection of DTOAvailabilityTypes

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown

get

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

Retrieves the required availability type by calling the AvailabilityTypeLoadEvent.

Parameters:

id - the ID of the availability type to be loaded

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

Returns:

the response containing the loaded availability type

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown