001
002package com.commercetools.api.models.order;
003
004import java.time.*;
005import java.util.*;
006import java.util.function.Function;
007
008import javax.annotation.Nullable;
009
010import com.fasterxml.jackson.annotation.*;
011import com.fasterxml.jackson.databind.annotation.*;
012
013import io.vrap.rmf.base.client.utils.Generated;
014
015/**
016 * OrderChangeShipmentStateAction
017 *
018 * <hr>
019 * Example to create an instance using the builder pattern
020 * <div class=code-example>
021 * <pre><code class='java'>
022 *     OrderChangeShipmentStateAction orderChangeShipmentStateAction = OrderChangeShipmentStateAction.builder()
023 *             .build()
024 * </code></pre>
025 * </div>
026 */
027@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
028@JsonDeserialize(as = OrderChangeShipmentStateActionImpl.class)
029public interface OrderChangeShipmentStateAction extends OrderUpdateAction {
030
031    /**
032     * discriminator value for OrderChangeShipmentStateAction
033     */
034    String CHANGE_SHIPMENT_STATE = "changeShipmentState";
035
036    /**
037     *
038     * @return shipmentState
039     */
040
041    @JsonProperty("shipmentState")
042    public ShipmentState getShipmentState();
043
044    /**
045     * set shipmentState
046     * @param shipmentState value to be set
047     */
048
049    public void setShipmentState(final ShipmentState shipmentState);
050
051    /**
052     * factory method
053     * @return instance of OrderChangeShipmentStateAction
054     */
055    public static OrderChangeShipmentStateAction of() {
056        return new OrderChangeShipmentStateActionImpl();
057    }
058
059    /**
060     * factory method to create a shallow copy OrderChangeShipmentStateAction
061     * @param template instance to be copied
062     * @return copy instance
063     */
064    public static OrderChangeShipmentStateAction of(final OrderChangeShipmentStateAction template) {
065        OrderChangeShipmentStateActionImpl instance = new OrderChangeShipmentStateActionImpl();
066        instance.setShipmentState(template.getShipmentState());
067        return instance;
068    }
069
070    /**
071     * factory method to create a deep copy of OrderChangeShipmentStateAction
072     * @param template instance to be copied
073     * @return copy instance
074     */
075    @Nullable
076    public static OrderChangeShipmentStateAction deepCopy(@Nullable final OrderChangeShipmentStateAction template) {
077        if (template == null) {
078            return null;
079        }
080        OrderChangeShipmentStateActionImpl instance = new OrderChangeShipmentStateActionImpl();
081        instance.setShipmentState(template.getShipmentState());
082        return instance;
083    }
084
085    /**
086     * builder factory method for OrderChangeShipmentStateAction
087     * @return builder
088     */
089    public static OrderChangeShipmentStateActionBuilder builder() {
090        return OrderChangeShipmentStateActionBuilder.of();
091    }
092
093    /**
094     * create builder for OrderChangeShipmentStateAction instance
095     * @param template instance with prefilled values for the builder
096     * @return builder
097     */
098    public static OrderChangeShipmentStateActionBuilder builder(final OrderChangeShipmentStateAction template) {
099        return OrderChangeShipmentStateActionBuilder.of(template);
100    }
101
102    /**
103     * accessor map function
104     * @param <T> mapped type
105     * @param helper function to map the object
106     * @return mapped value
107     */
108    default <T> T withOrderChangeShipmentStateAction(Function<OrderChangeShipmentStateAction, T> helper) {
109        return helper.apply(this);
110    }
111
112    /**
113     * gives a TypeReference for usage with Jackson DataBind
114     * @return TypeReference
115     */
116    public static com.fasterxml.jackson.core.type.TypeReference<OrderChangeShipmentStateAction> typeReference() {
117        return new com.fasterxml.jackson.core.type.TypeReference<OrderChangeShipmentStateAction>() {
118            @Override
119            public String toString() {
120                return "TypeReference<OrderChangeShipmentStateAction>";
121            }
122        };
123    }
124}