CommonTransportUnitVO.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.transport.spi;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;
import org.ameba.http.AbstractBase;
import org.openwms.common.location.api.LocationVO;
import org.openwms.common.transport.api.ValidationGroups;

import java.io.Serializable;
import java.util.Date;
import java.util.Objects;

/**
 * A TransportUnitVO.
 *
 * @author Heiko Scherrer
 */
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public class CommonTransportUnitVO extends AbstractBase<CommonTransportUnitVO> implements Serializable {

    /** The persistent key. */
    @JsonProperty("pKey")
    private String pKey;
    @NotEmpty(message = "{owms.common.common.tu.barcode}")
    @JsonProperty("barcode")
    private String barcode;
    @NotNull(message = "{owms.common.common.tu.actualLocation}", groups = ValidationGroups.TransportUnit.Create.class)
    @JsonProperty("actualLocation")
    private LocationVO actualLocation;
    /** The state of the TransportUnit. */
    @JsonProperty("state")
    private String state;
    @JsonProperty("toLocation")
    private String target;
    @NotEmpty(message = "{owms.common.common.tu.transportUnitTypeName}", groups = {ValidationGroups.TransportUnit.Create.class, ValidationGroups.TransportUnit.WithTuT.class})
    @JsonProperty("transportUnitType")
    private CommonTransportUnitTypeVO transportUnitType;
    @JsonProperty("length")
    private Integer length;
    @JsonProperty("width")
    private Integer width;
    @JsonProperty("height")
    private Integer height;
    @JsonProperty("actualPlcCode")
    private String actualPlcCode;
    @JsonProperty("actualLocationDate")
    private Date actualLocationDate;
    @JsonProperty("createDate")
    private Date createDate;
    /** An optional assignment to a customer order. */
    @JsonProperty("customerOrderId")
    private String customerOrderId;

    /*~-------------------- constructors --------------------*/
    @JsonCreator
    protected CommonTransportUnitVO() {
    }

    public CommonTransportUnitVO(String barcode) {
        this.barcode = barcode;
    }

    public CommonTransportUnitVO(String barcode, CommonTransportUnitTypeVO transportUnitType, LocationVO actualLocation) {
        this.barcode = barcode;
        this.transportUnitType = transportUnitType;
        this.actualLocation = actualLocation;
    }

    private CommonTransportUnitVO(Builder builder) {
        barcode = builder.barcode;
        actualLocation = builder.actualLocation;
        target = builder.target;
        transportUnitType = builder.transportUnitType;
        length = builder.length;
        width = builder.width;
        height = builder.height;
        actualPlcCode = builder.actualPlcCode;
        actualLocationDate = builder.actualLocationDate;
        createDate = builder.createDate;
    }

    public static Builder newBuilder() {
        return new Builder();
    }

    public static Builder builder() {
        return new Builder();
    }

    /*~-------------------- accessors --------------------*/
    public String getpKey() {
        return pKey;
    }

    public void setpKey(String pKey) {
        this.pKey = pKey;
    }

    public String getBarcode() {
        return barcode;
    }

    public void setBarcode(String barcode) {
        this.barcode = barcode;
    }

    public LocationVO getActualLocation() {
        return actualLocation;
    }

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

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }

    public String getTarget() {
        return target;
    }

    public void setTarget(String target) {
        this.target = target;
    }

    public CommonTransportUnitTypeVO getTransportUnitType() {
        return transportUnitType;
    }

    public void setTransportUnitType(CommonTransportUnitTypeVO transportUnitType) {
        this.transportUnitType = transportUnitType;
    }

    public Integer getLength() {
        return length;
    }

    public void setLength(Integer length) {
        this.length = length;
    }

    public Integer getWidth() {
        return width;
    }

    public void setWidth(Integer width) {
        this.width = width;
    }

    public Integer getHeight() {
        return height;
    }

    public void setHeight(Integer height) {
        this.height = height;
    }

    public String getActualPlcCode() {
        return actualPlcCode;
    }

    public void setActualPlcCode(String actualPlcCode) {
        this.actualPlcCode = actualPlcCode;
    }

    public Date getActualLocationDate() {
        return actualLocationDate;
    }

    public void setActualLocationDate(Date actualLocationDate) {
        this.actualLocationDate = actualLocationDate;
    }

    public Date getCreateDate() {
        return createDate;
    }

    public void setCreateDate(Date createDate) {
        this.createDate = createDate;
    }

    public String getCustomerOrderId() {
        return customerOrderId;
    }

    public void setCustomerOrderId(String customerOrderId) {
        this.customerOrderId = customerOrderId;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof CommonTransportUnitVO)) return false;
        if (!super.equals(o)) return false;
        CommonTransportUnitVO that = (CommonTransportUnitVO) o;
        return Objects.equals(barcode, that.barcode) &&
                Objects.equals(actualLocation, that.actualLocation) &&
                Objects.equals(target, that.target) &&
                Objects.equals(transportUnitType, that.transportUnitType) &&
                Objects.equals(length, that.length) &&
                Objects.equals(width, that.width) &&
                Objects.equals(height, that.height) &&
                Objects.equals(actualPlcCode, that.actualPlcCode) &&
                Objects.equals(actualLocationDate, that.actualLocationDate) &&
                Objects.equals(createDate, that.createDate);
    }

    @Override
    public int hashCode() {
        return Objects.hash(super.hashCode(), barcode, actualLocation, target, transportUnitType, length, width, height, actualPlcCode, actualLocationDate, createDate);
    }

    /*~-------------------- Builder --------------------*/
    public static final class Builder {
        private @NotBlank String barcode;
        private LocationVO actualLocation;
        private String target;
        private @NotNull(groups = ValidationGroups.TransportUnit.WithTuT.class) CommonTransportUnitTypeVO transportUnitType;
        private Integer length;
        private Integer width;
        private Integer height;
        private String actualPlcCode;
        private Date actualLocationDate;
        private Date createDate;

        private Builder() {
        }

        public Builder barcode(@NotBlank String val) {
            barcode = val;
            return this;
        }

        public Builder actualLocation(LocationVO val) {
            actualLocation = val;
            return this;
        }

        public Builder target(String val) {
            target = val;
            return this;
        }

        public Builder transportUnitType(@NotNull(groups = ValidationGroups.TransportUnit.WithTuT.class) CommonTransportUnitTypeVO val) {
            transportUnitType = val;
            return this;
        }

        public Builder length(Integer val) {
            length = val;
            return this;
        }

        public Builder width(Integer val) {
            width = val;
            return this;
        }

        public Builder height(Integer val) {
            height = val;
            return this;
        }

        public Builder actualPlcCode(String val) {
            actualPlcCode = val;
            return this;
        }

        public Builder actualLocationDate(Date val) {
            actualLocationDate = val;
            return this;
        }

        public Builder createDate(Date val) {
            createDate = val;
            return this;
        }

        public CommonTransportUnitVO build() {
            return new CommonTransportUnitVO(this);
        }
    }
}