Package overit.geocallapp.wfm.forecastcapacity.rs1.forecast.activity.header

Class ActivityForecastHeaderService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.activity.header.ActivityForecastHeaderService

@RestController
@RequestMapping("planning/forecast-capacity/r1/activity-forecasts")
@Resource(logging=true)
public class ActivityForecastHeaderService
extends PrivateService

Services to manage a BOActivityForecastHeader object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ActivityForecastHeaderService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long id)	Logically cancels the required BOActivityForecastHeader object by calling the ActivityForecastHeaderCancelEvent event
org.springframework.http.ResponseEntity<DTOForecastActivity>	get(Long id, Collection<String> fields)	Retrieves the required BOActivityForecastHeader object by calling the ActivityForecastHeaderLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOActivityForecastHeader>>	getCollection(@Valid Page page, String order, Collection<String> fields, @Valid DTOActivityForecastHeaderSearchFilter filter)	Returns the collection of all the stored BOActivityForecastHeader objects by calling the ActivityForecastHeaderSearchEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOForecastActivityUpdate dto)	Updates the required BOActivityForecastHeader object by calling the ActivityForecastHeaderUpdateEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOActivityForecastHeaderInsert dto)	Creates a new BOActivityForecastHeader object by calling the ActivityForecastHeaderInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ActivityForecastHeaderService

public ActivityForecastHeaderService()

Method Details

getCollection

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

Returns the collection of all the stored BOActivityForecastHeader objects by calling the ActivityForecastHeaderSearchEvent event

Parameters:

filter - the DTOActivityForecastHeaderSearchFilter object

Returns:

the collection of DTOActivityForecastHeaders

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOActivityForecastHeader object by calling the ActivityForecastHeaderLoadEvent event

Parameters:

id - the BOActivityForecastHeader's id field

Returns:

the response containing the loaded DTOActivityForecastHeader

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

post

@PostMapping(consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<DTOIdentifier<Long>> post(@Valid @RequestBody
 @Valid DTOActivityForecastHeaderInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new BOActivityForecastHeader object by calling the ActivityForecastHeaderInsertEvent event

Parameters:

dto - the DTOActivityForecastHeaderInsert object

Returns:

the response containing the ID of the newly created BOActivityForecastHeader

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

@PatchMapping(value="{activityForecastId:[0-9]+}",
              consumes="application/json",
              produces="application/json")
public org.springframework.http.ResponseEntity<Void> patch(@PathVariable("activityForecastId")
 Long id,
 @Valid @RequestBody
 @Valid DTOForecastActivityUpdate dto)
                                                    throws DAValidateException,
DAException

Updates the required BOActivityForecastHeader object by calling the ActivityForecastHeaderUpdateEvent event

Parameters:

id - the id of the BOActivityForecastHeader object to be updated

dto - the DTOActivityForecastHeaderUpdate object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

@DeleteMapping(value="{activityForecastId:[0-9]+}",
               produces="application/json")
public org.springframework.http.ResponseEntity<Void> delete(@PathVariable("activityForecastId")
 Long id)
                                                     throws DAValidateException,
DAException

Logically cancels the required BOActivityForecastHeader object by calling the ActivityForecastHeaderCancelEvent event

Parameters:

id - the id of the BOActivityForecastHeader object to be logically cancelled

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception