MovePURequestVO.java

/*
 * Copyright 2005-2025 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.openwms.wms.inventory.api;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import jakarta.validation.constraints.NotNull;
import org.openwms.core.units.api.Measurable;
import org.openwms.wms.location.api.LocationVO;

import java.util.StringJoiner;

/**
 * A MovePURequestVO.
 *
 * @author Heiko Scherrer
 */
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class MovePURequestVO {

    /** Product to move. */
    @JsonProperty("product")
    @NotNull
    private ProductVO product;
    /** Quantity to move. */
    @JsonProperty("quantity")
    private Measurable quantity;
    @JsonProperty("targetTransportUnitBK")
    private String targetTransportUnitBK;
    @JsonProperty("targetLoadUnitPosition")
    private String targetLoadUnitPosition;
    @JsonProperty("actualLocation")
    private LocationVO actualLocation;
    @JsonProperty("targetLocation")
    private LocationVO targetLocation;

    public ProductVO getProduct() {
        return product;
    }

    public void setProduct(ProductVO product) {
        this.product = product;
    }

    public Measurable getQuantity() {
        return quantity;
    }

    public void setQuantity(Measurable quantity) {
        this.quantity = quantity;
    }

    public boolean hasQuantity() {
        return this.quantity != null;
    }

    public String getTargetTransportUnitBK() {
        return targetTransportUnitBK;
    }

    public boolean hasTargetTransportUnitBK() {
        return targetTransportUnitBK != null && !getTargetTransportUnitBK().isEmpty();
    }

    public void setTargetTransportUnitBK(String targetTransportUnitBK) {
        this.targetTransportUnitBK = targetTransportUnitBK;
    }

    public String getTargetLoadUnitPosition() {
        return targetLoadUnitPosition;
    }

    public boolean hasTargetLoadUnitPosition() {
        return targetLoadUnitPosition != null && !targetLoadUnitPosition.isEmpty();
    }

    public void setTargetLoadUnitPosition(String targetLoadUnitPosition) {
        this.targetLoadUnitPosition = targetLoadUnitPosition;
    }

    public LocationVO getActualLocation() {
        return actualLocation;
    }

    public boolean hasActualLocation() {
        return actualLocation != null;
    }

    public void setActualLocation(LocationVO actualLocation) {
        this.actualLocation = actualLocation;
    }

    public LocationVO getTargetLocation() {
        return targetLocation;
    }

    public void setTargetLocation(LocationVO targetLocation) {
        this.targetLocation = targetLocation;
    }

    @Override
    public String toString() {
        return new StringJoiner(", ", MovePURequestVO.class.getSimpleName() + "[", "]")
                .add("product=" + product)
                .add("quantity=" + quantity)
                .add("targetTransportUnitBK='" + targetTransportUnitBK + "'")
                .add("targetLoadUnitPosition='" + targetLoadUnitPosition + "'")
                .add("actualLocation=" + actualLocation)
                .add("targetLocation=" + targetLocation)
                .toString();
    }
}