Package org.openwms.tms.routing.location

Interface LocationService

All Known Implementing Classes:

LocationServiceImpl

public interface LocationService

A LocationService.

Author:

Heiko Scherrer

Method Summary

Modifier and Type	Method	Description
void	delete(@NotBlank String foreignPKey)	Deletes a Location with the given foreign persistent key.
Optional<LocationEO>	findByLocationId(@NotBlank String locationId)	Find a Location by its given locationId.
boolean	isRemovalAllowed(@NotNull List<String> foreignPKeys)	Requests the removal of Locations identified by the foreign persistent keys.
void	markForRemoval(@NotNull List<String> foreignPKeys)	Mark Locations identified by the given keys for removal.
void	rollbackDeletionMark(@NotBlank String foreignPKey)	Unset a previously set removal marker on the Location with the given foreign persistent key.

Method Details

isRemovalAllowed

boolean isRemovalAllowed(@NotNull
 @NotNull List<String> foreignPKeys)

Requests the removal of Locations identified by the foreign persistent keys.

Parameters:

foreignPKeys - The foreign persistent keys of the Locations to be deleted

Returns:

true if deletion of Locations is allowed

markForRemoval

void markForRemoval(@NotNull
 @NotNull List<String> foreignPKeys)

Mark Locations identified by the given keys for removal.

Parameters:

foreignPKeys - The foreign persistent keys of the Locations to be removed

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.

findByLocationId

Optional<LocationEO> findByLocationId(@NotBlank
 @NotBlank String locationId)

Find a Location by its given locationId.

Parameters:

locationId - The ID of the Location must not be blank

Returns:

Optional instance of the Location