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

Class ActivityForecastPriorityService

java.lang.Object

overit.geocallapp.utilities.rs.common.PrivateService

overit.geocallapp.wfm.forecastcapacity.rs1.forecast.activity.priority.ActivityForecastPriorityService

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

Services to manage a BOForecastActivityPriority object.

Since:

15.0

GCApi:

rest

Constructor Summary

Constructors

Constructor	Description
ActivityForecastPriorityService()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	delete(Long id)	Disable the required BOForecastActivityPriority object by calling the ForecastActivityPriorityDisableEvent event
org.springframework.http.ResponseEntity<DTOActivityForecastPriority>	get(Long id, Collection<String> fields)	Retrieves the required BOForecastActivityPriority object by calling the ForecastActivityPriorityLoadEvent event
org.springframework.http.ResponseEntity<PageResponse<DTOActivityForecastPriority>>	getCollection(@Valid Page page, String order, Collection<String> fields, @Valid DTOActivityForecastPrioritySearchFilter filter)	Returns the collection of all the stored BOForecastActivityPriority objects by calling the ForecastActivityPrioritySearchEvent event
org.springframework.http.ResponseEntity<Void>	patch(Long id, @Valid DTOActivityForecastPriorityUpdate dto)	Updates the required BOForecastActivityPriority object by calling the ForecastActivityPriorityUpdateEvent event
org.springframework.http.ResponseEntity<DTOIdentifier<Long>>	post(@Valid DTOActivityForecastPriorityInsert dto)	Creates a new BOForecastActivityPriority object by calling the ForecastActivityPriorityInsertEvent event

Methods inherited from class java.lang.Object

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

Constructor Details

ActivityForecastPriorityService

public ActivityForecastPriorityService()

Method Details

getCollection

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

Returns the collection of all the stored BOForecastActivityPriority objects by calling the ForecastActivityPrioritySearchEvent event

Parameters:

filter - the DTOActivityForecastPrioritySearchFilter object

Returns:

the collection of DTOActivityForecastPrioritys

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

get

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

Retrieves the required BOForecastActivityPriority object by calling the ForecastActivityPriorityLoadEvent event

Parameters:

id - the BOForecastActivityPriority object's id

Returns:

the response containing the loaded DTOActivityForecastPriority

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 DTOActivityForecastPriorityInsert dto)
                                                                  throws DAValidateException,
DAException

Creates a new BOForecastActivityPriority object by calling the ForecastActivityPriorityInsertEvent event

Parameters:

dto - the DTOActivityForecastPriorityInsert object

Returns:

the response containing the ID of the newly created BOForecastActivityPriority

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

patch

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

Updates the required BOForecastActivityPriority object by calling the ForecastActivityPriorityUpdateEvent event

Parameters:

id - the id of the BOForecastActivityPriority object to be updated

dto - the DTOActivityForecastPriorityUpdate object

Returns:

the standard response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception

delete

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

Disable the required BOForecastActivityPriority object by calling the ForecastActivityPriorityDisableEvent event

Parameters:

id - the id of the BOForecastActivityPriority object to disable

Returns:

the DTO response

Throws:

DAValidateException - the DA validate exception

DAException - the DA exception