Package org.openwms.common.location.api

Interface TargetApi

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

A TargetApi offers operations on Targets (i.e. resources), like locking and releasing a resource.

Author:

Heiko Scherrer

Method Summary

Modifier and Type	Method	Description
void	changeState(String targetBK, LockType type, LockMode mode)	Change the current mode a Target, identified by targetBK operates in.
void	lock(String targetBK, Boolean reallocation)	Lock the Target identified by targetBK.
void	release(String targetBK)	Unlock or release the Target identified by targetBK.

Method Details

changeState

@PostMapping(value="/v1/targets/{targetBK}",
             params={"type","mode","op=change-state"})
void changeState(@PathVariable("targetBK")
 String targetBK,
 @RequestParam("type")
 LockType type,
 @RequestParam("mode")
 LockMode mode)

Change the current mode a Target, identified by targetBK operates in.

Parameters:

targetBK - The business key of the Target, can be a LocationPK in String format or a LocationGroup name

type - The type of lock to apply to the Target

mode - The mode to apply to the Targets lock

lock

@PostMapping(value="/v1/targets/{targetBK}",
             params="op=lock")
void lock(@PathVariable("targetBK")
 String targetBK,
 @RequestParam("reallocation")
 Boolean reallocation)

Lock the Target identified by targetBK.

Parameters:

targetBK - The business key of the Target, can be a LocationPK in String format or a LocationGroup name

reallocation - If true open outfeed orders will be re-allocated

release

@PostMapping(value="/v1/targets/{targetBK}",
             params="op=unlock")
void release(@PathVariable("targetBK")
 String targetBK)

Unlock or release the Target identified by targetBK.

Parameters:

targetBK - The business key of the Target, can be a LocationPK in String format or a LocationGroup name