Package org.openwms.common.location.api

Interface LocationGroupApi

@FeignClient(name="common-service",
             dismiss404=true,
             qualifiers="locationGroupApi")
public interface LocationGroupApi

A LocationGroupApi.

Author:

Heiko Scherrer

Method Summary

Modifier and Type	Method	Description
void	changeGroupState(String name, String op, ErrorCodeVO errorCode)	Change the state of an existing LocationGroup.
void	changeGroupState(String pKey, String op, LocationGroupState stateIn, LocationGroupState stateOut)	Change the state of an existing LocationGroup.
List<LocationGroupVO>	findAll()	Find and return all existing LocationGroups.
Optional<LocationGroupVO>	findByName(String name)	Find a LocationGroup with the given name.
List<LocationGroupVO>	findByNames(List<String> names)	Find all LocationGroups with the given names.

Method Details

findByName

@GetMapping(value="/v1/location-groups",
            params="name")
@Cacheable("locationGroups")
Optional<LocationGroupVO> findByName(@RequestParam("name")
 String name)

Find a LocationGroup with the given name.

Parameters:

name - The name of the LocationGroup

Returns:

The instance or may result in a 404-Not Found

findByNames

@GetMapping(value="/v1/location-groups",
            params="names")
@Cacheable("locationGroups")
List<LocationGroupVO> findByNames(@RequestParam("names")
 List<String> names)

Find all LocationGroups with the given names.

Parameters:

names - Names of all LocationGroups

Returns:

A list of instances or an empty list but never null

findAll

@GetMapping("/v1/location-groups")
List<LocationGroupVO> findAll()

Find and return all existing LocationGroups.

Returns:

Never null

changeGroupState

@PatchMapping(value="/v1/location-groups",
              params={"name","op=change-state"})
void changeGroupState(@RequestParam(name="name")
 String name,
 @RequestParam(name="op")
 String op,
 @RequestBody
 ErrorCodeVO errorCode)

Change the state of an existing LocationGroup.

Parameters:

name - The name of the LocationGroup

errorCode - The decoded state

changeGroupState

@PatchMapping(value="/v1/location-group/{pKey}",
              params="op=change-state")
void changeGroupState(@PathVariable("pKey")
 String pKey,
 @RequestParam(name="op")
 String op,
 @RequestParam(name="statein",required=false)
 LocationGroupState stateIn,
 @RequestParam(name="stateout",required=false)
 LocationGroupState stateOut)

Change the state of an existing LocationGroup.

Parameters:

pKey - The persistent key of the LocationGroup

stateIn - The inbound state to set

stateOut - The outbound state to set