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