Package org.openwms.wms.movements.api

Interface MovementApi

@FeignClient(name="movement-service",
             qualifiers="movementApi",
             decode404=true)
public interface MovementApi

A MovementApi is the public outer API that can be used by clients.

Author:

Heiko Scherrer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_MOVEMENTS	API root to hit Movements (plural).
static final String	API_VERSION	API version.

Method Summary

Modifier and Type	Method	Description
MovementVO	create(String bk, MovementVO movement)	Create a Movement for a TransportUnit.
List<MovementVO>	findForStateAndTypes(String state, MovementType... types)	Find and return Movements.
List<MovementVO>	findForTuAndTypesAndStates(String barcode, List<String> types, List<String> states)	Find and return all Movements order for TransportUnits.

Field Details

API_VERSION

static final String API_VERSION

API version.

See Also:

• Constant Field Values

API_MOVEMENTS

static final String API_MOVEMENTS

API root to hit Movements (plural).

See Also:

• Constant Field Values

Method Details

create

@PostMapping("/v1/transport-units/{bk}/movements")
MovementVO create(@PathVariable("bk")
 String bk,
 @RequestBody
 MovementVO movement)

Create a Movement for a TransportUnit.

Parameters:

bk - The identifying business key of the TransportUnit

movement - The details of the Movement

findForStateAndTypes

@GetMapping(value="/v1/movements",
            params={"state","types"})
List<MovementVO> findForStateAndTypes(@RequestParam("state")
 String state,
 @RequestParam("types")
 MovementType... types)

Find and return Movements.

Parameters:

state - The state the Movement shall reside in

types - Allowed types of Movements to search for

Returns:

A list of all instances, never null

findForTuAndTypesAndStates

@GetMapping(value="v1/movements",
            params={"barcode","types","states"})
List<MovementVO> findForTuAndTypesAndStates(@RequestParam("barcode")
 String barcode,
 @RequestParam("types")
 List<String> types,
 @RequestParam("states")
 List<String> states)

Find and return all Movements order for TransportUnits.

Parameters:

barcode - The business key of the TransportUnit

types - A list of types the Movements must resist in

states - A list of states the Movements must resist in

Returns:

A list of all instances, never null