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

Class ForecastActivityService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.activity.forecastactivity.ForecastActivityService

@RestController
@RequestMapping("planning/forecast-capacity/r1/activity-forecasts/{activityForecastId:[0-9]+}/activities")
@Resource(logging=true)
public class ForecastActivityService
extends PrivateService

Services to manage a BOForecastActivity object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ForecastActivityService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long forecastHeaderId, Long id)	Deletes the required BOForecastActivity object from a given BOActivityForecastHeader object by calling the ForecastActivityDeleteEvent event
org.springframework.http.ResponseEntity<DTOForecastActivity>	get(Long forecastHeaderId, Long id, Collection<String> fields)	Retrieves the required BOForecastActivity object by calling the ForecastActivityLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOForecastActivity>>	getCollection(@Valid Page page, String order, Collection<String> fields, Long forecastHeaderId, @Valid DTOForecastActivitySearchFilter filter)	Returns the collection of all the stored BOForecastActivity objects by calling the ForecastActivitySearchEvent event
org.springframework.http.ResponseEntity<Void>	importFromCo(Long forecastHeaderId, @Valid DTOForecastActivityImportFromCO dto)	Import a real activity as a BOForecastActivity object by calling the ForecastActivityImportOperationActivityEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long forecastHeaderId, Long id, @Valid DTOForecastActivityUpdate dto)	Updates a BOForecastActivity object by calling the ForecastActivityUpdateEvent.
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(Long forecastHeaderId, @Valid DTOForecastActivityInsert dto)	Creates a new BOForecastActivity object by calling the ForecastActivityInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ForecastActivityService

public ForecastActivityService()

Method Details

getCollection

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

Returns the collection of all the stored BOForecastActivity objects by calling the ForecastActivitySearchEvent event

Parameters:

forecastHeaderId - the BOForecastActivity's forecastHeader field

filter - the DTOForecastActivitySearchFilter object

Returns:

the collection of DTOForecastActivitys

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOForecastActivity object by calling the ForecastActivityLoadEvent event

Parameters:

forecastHeaderId - the BOForecastActivity object's forecastHeader field

id - the BOForecastActivity object's id field

Returns:

the response containing the loaded DTOForecastActivity

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(@PathVariable("activityForecastId")
 Long forecastHeaderId,
 @Valid @RequestBody
 @Valid DTOForecastActivityInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new BOForecastActivity object by calling the ForecastActivityInsertEvent event

Parameters:

forecastHeaderId - the BOForecastActivity object 's forecastHeader field

dto - the DTOForecastActivityInsert object

Returns:

the response containing the ID of the newly created BOForecastActivity

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates a BOForecastActivity object by calling the ForecastActivityUpdateEvent.

Parameters:

forecastHeaderId - the BOForecastActivity object's forecastHeader field

id - the id of the BOForecastActivity object to update

dto - the DTOForecastActivityUpdate object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

importFromCo

@PostMapping(value="import-from-operation-centers",
             consumes="application/json",
             produces="application/json")
public org.springframework.http.ResponseEntity<Void> importFromCo(@PathVariable("activityForecastId")
 Long forecastHeaderId,
 @Valid @RequestBody
 @Valid DTOForecastActivityImportFromCO dto)
                                                           throws DAValidateException,
DAException

Import a real activity as a BOForecastActivity object by calling the ForecastActivityImportOperationActivityEvent event

Parameters:

forecastHeaderId - the BOForecastActivity object 's forecastHeader field

dto - the DTOForecastActivityImportFromCO object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

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

Deletes the required BOForecastActivity object from a given BOActivityForecastHeader object by calling the ForecastActivityDeleteEvent event

Parameters:

forecastHeaderId - the BOForecastActivity object's forecastHeader field

id - the id of the BOForecastActivity object to delete

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception