Package org.openwms.common.location

Class WorkflowApi

java.lang.Object

org.openwms.core.http.AbstractWebController

org.openwms.common.location.WorkflowApi

@Profile("!INMEM")
@Validated
@MeasuredRestController
public class WorkflowApi
extends org.openwms.core.http.AbstractWebController

A WorkflowApi.

Author:

Heiko Scherrer

Field Summary

Fields

Modifier and Type	Field	Description
private final LocationService	locationService
private final LocationMapper	mapper
private final org.ameba.i18n.Translator	translator

Constructor Summary

Constructors

Constructor	Description
WorkflowApi(LocationService locationService, LocationMapper mapper, org.ameba.i18n.Translator translator)

Method Summary

Modifier and Type	Method	Description
private void	addSelfLink(LocationVO result)
org.springframework.http.ResponseEntity<Optional<LocationVO>>	createLocation(@Valid LocationVO location, jakarta.servlet.http.HttpServletRequest req)
org.springframework.http.ResponseEntity<Optional<LocationVO>>	findByErpCodeOpt(String erpCode)
org.springframework.http.ResponseEntity<Optional<LocationVO>>	findByIdOpt(String locationId)
org.springframework.http.ResponseEntity<Optional<LocationVO>>	findByPKeyOpt(String pKey)
org.springframework.http.ResponseEntity<Optional<LocationVO>>	findByPlcCodeOpt(String plcCode)
org.springframework.http.ResponseEntity<Optional<LocationVO>>	updateLocation(@Valid LocationVO location)

Methods inherited from class org.openwms.core.http.AbstractWebController

buildNOKResponse, buildNOKResponseWithKey, buildOKResponse, buildResponse, buildResponse, getLocationForCreatedResource, getLocationURIForCreatedResource, handleBehaviorAwareException, handleBusinessRuntimeException, handleConstraintViolationException, handleException, handleHttpBusinessException, handleRemovalNotAllowedException, handleTechnicalRuntimeException, handleValidationException, illegalArgumentException, translate

Methods inherited from class java.lang.Object

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

Field Details

mapper

private final LocationMapper mapper

translator

private final org.ameba.i18n.Translator translator

locationService

private final LocationService locationService

Constructor Details

WorkflowApi

WorkflowApi(LocationService locationService,
 LocationMapper mapper,
 org.ameba.i18n.Translator translator)

Method Details

createLocation

@PostMapping(value="/v1/locations",
             produces="application/vnd.openwms.common.location-opt-v1+json")
@Validated(Create.class)
public org.springframework.http.ResponseEntity<Optional<LocationVO>> createLocation(@Valid @RequestBody
 @Valid LocationVO location,
 jakarta.servlet.http.HttpServletRequest req)

updateLocation

@PutMapping(value="/v1/locations",
            produces="application/vnd.openwms.common.location-opt-v1+json")
@Validated(Update.class)
public org.springframework.http.ResponseEntity<Optional<LocationVO>> updateLocation(@Valid @RequestBody
 @Valid LocationVO location)

findByPKeyOpt

@GetMapping(value="/v1/locations/{pKey}",
            produces="application/vnd.openwms.common.location-opt-v1+json")
public org.springframework.http.ResponseEntity<Optional<LocationVO>> findByPKeyOpt(@PathVariable("pKey")
 String pKey)

addSelfLink

private void addSelfLink(LocationVO result)

findByIdOpt

@GetMapping(value="/v1/locations",
            params="locationId",
            produces="application/vnd.openwms.common.location-opt-v1+json")
public org.springframework.http.ResponseEntity<Optional<LocationVO>> findByIdOpt(@RequestParam("locationId")
 String locationId)

findByErpCodeOpt

@GetMapping(value="/v1/locations",
            params="erpCode",
            produces="application/vnd.openwms.common.location-opt-v1+json")
public org.springframework.http.ResponseEntity<Optional<LocationVO>> findByErpCodeOpt(@RequestParam("erpCode")
 String erpCode)

findByPlcCodeOpt

@GetMapping(value="/v1/locations",
            params="plcCode",
            produces="application/vnd.openwms.common.location-opt-v1+json")
public org.springframework.http.ResponseEntity<Optional<LocationVO>> findByPlcCodeOpt(@RequestParam("plcCode")
 String plcCode)