ShippingOrderUpdater.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.shipping;

import jakarta.validation.Valid;
import jakarta.validation.constraints.NotNull;
import org.openwms.wms.shipping.impl.ShippingOrder;
import org.springframework.plugin.core.Plugin;

/**
 * A ShippingOrderUpdater.
 *
 * @author Heiko Scherrer
 */
public interface ShippingOrderUpdater extends Plugin<ShippingOrderUpdater.Type> {

    enum Type {
        STATE_CHANGE
    }

    /**
     * Update the given {@code existingShippingOrder} partially with the contents of {@code shippingOrder}.
     *
     * @param existingShippingOrder The existing instance
     * @param shippingOrder Contains the properties to update
     * @return The updated instance
     */
    ShippingOrder update(@NotNull ShippingOrder existingShippingOrder,
                         @Valid @NotNull ShippingOrder shippingOrder);
}