Package org.openwms.wms.location

Interface LocationSynchronizer

All Known Implementing Classes:

LocationSynchronizerImpl

public interface LocationSynchronizer

A LocationSynchronizer is used to synchronize the state of Locations with the golden source.

Author:

Heiko Scherrer

Method Summary

Modifier and Type	Method	Description
void	changeState(@NotBlank String foreignPKey, Boolean incomingActive, Boolean outgoingActive, Integer plcState)	Change the state of a Location.
void	create(@NotNull org.openwms.common.location.api.messages.LocationMO location)	Create a new Location on demand.
void	delete(@NotBlank String foreignPKey)	Deletes a Location with the given foreign persistent key.
void	rollbackDeletionMark(@NotBlank String foreignPKey)	Unset a previously set removal marker on the Location with the given foreign persistent key.

Method Details

create

void create(@NotNull
 @NotNull org.openwms.common.location.api.messages.LocationMO location)

Create a new Location on demand.

Parameters:

location - The instance to create

changeState

void changeState(@NotBlank
 @NotBlank String foreignPKey,
 Boolean incomingActive,
 Boolean outgoingActive,
 Integer plcState)

Change the state of a Location.

Parameters:

foreignPKey - The foreign persistent key of the Location instance

incomingActive - The state for incoming or inbound goods

outgoingActive - The state for outgoing or outbound goods

plcState - The PLC state of the Location

delete

void delete(@NotBlank
 @NotBlank String foreignPKey)

Deletes a Location with the given foreign persistent key.

Parameters:

foreignPKey - The foreign persistent key of the Location instance.

Throws:

IllegalArgumentException - If the parameter 'foreignPKey' is blank.

rollbackDeletionMark

void rollbackDeletionMark(@NotBlank
 @NotBlank String foreignPKey)

Unset a previously set removal marker on the Location with the given foreign persistent key.

Parameters:

foreignPKey - The foreign persistent key of the Location instance.