Package overit.geocallapp.wfm.forecastcapacity.rs1.capacityplanning.state

Class CapacityPlanningStateService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.capacityplanning.state.CapacityPlanningStateService

@RestController
@RequestMapping("planning/forecast-capacity/r1/capacity-plannings/states")
@Resource(logging=true)
public class CapacityPlanningStateService
extends PrivateService

Services to manage a BOCapacityPlanningState object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
CapacityPlanningStateService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<DTOCapacityPlanningState>	get(Long id, String language, Collection<String> fields)	Retrieves the required BOCapacityPlanningState object by calling the CapacityPlanningStateLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOCapacityPlanningState>>	getCollection(@Valid Page page, String order, String language, Collection<String> fields, @Valid DTOCapacityPlanningStateSearchFilter filter)	Returns the collection of all the stored BOCapacityPlanningState objects by calling the CapacityPlanningStateSearchEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

CapacityPlanningStateService

public CapacityPlanningStateService()

Method Details

getCollection

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

Returns the collection of all the stored BOCapacityPlanningState objects by calling the CapacityPlanningStateSearchEvent event

Parameters:

page - the page

order - the order

language - the language of the user

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

filter - the DTOCapacityPlanningStateSearchFilter object

Returns:

the collection of DTOCapacityPlanningStates

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

@GetMapping(value="{stateId:[0-9]+}",
            produces="application/json")
public org.springframework.http.ResponseEntity<DTOCapacityPlanningState> get(@PathVariable("stateId")
 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 BOCapacityPlanningState object by calling the CapacityPlanningStateLoadEvent event

Parameters:

id - the BOCapacityPlanningState object's id field

language - the language of the user

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

Returns:

the response containing the loaded DTOCapacityPlanningState

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception is thrown