001
002package com.commercetools.history.models.change;
003
004import java.time.*;
005import java.util.*;
006import java.util.function.Function;
007
008import javax.annotation.Nullable;
009import javax.validation.Valid;
010import javax.validation.constraints.NotNull;
011
012import com.commercetools.history.models.common.LocalizedString;
013import com.commercetools.history.models.common.Reference;
014import com.fasterxml.jackson.annotation.*;
015import com.fasterxml.jackson.databind.annotation.*;
016
017import io.vrap.rmf.base.client.utils.Generated;
018
019/**
020 *  <p>Change triggered by the Set LineItem DistributionChannel update action.</p>
021 *
022 * <hr>
023 * Example to create an instance using the builder pattern
024 * <div class=code-example>
025 * <pre><code class='java'>
026 *     SetLineItemDistributionChannelChange setLineItemDistributionChannelChange = SetLineItemDistributionChannelChange.builder()
027 *             .change("{change}")
028 *             .previousValue(previousValueBuilder -> previousValueBuilder)
029 *             .nextValue(nextValueBuilder -> nextValueBuilder)
030 *             .lineItem(lineItemBuilder -> lineItemBuilder)
031 *             .variant("{variant}")
032 *             .build()
033 * </code></pre>
034 * </div>
035 */
036@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
037@JsonDeserialize(as = SetLineItemDistributionChannelChangeImpl.class)
038public interface SetLineItemDistributionChannelChange extends Change {
039
040    /**
041     * discriminator value for SetLineItemDistributionChannelChange
042     */
043    String SET_LINE_ITEM_DISTRIBUTION_CHANNEL_CHANGE = "SetLineItemDistributionChannelChange";
044
045    /**
046     *
047     * @return type
048     */
049    @NotNull
050    @JsonProperty("type")
051    public String getType();
052
053    /**
054     *
055     * @return change
056     */
057    @NotNull
058    @JsonProperty("change")
059    public String getChange();
060
061    /**
062     *  <p>Value before the change.</p>
063     * @return previousValue
064     */
065    @NotNull
066    @Valid
067    @JsonProperty("previousValue")
068    public Reference getPreviousValue();
069
070    /**
071     *  <p>Value after the change.</p>
072     * @return nextValue
073     */
074    @NotNull
075    @Valid
076    @JsonProperty("nextValue")
077    public Reference getNextValue();
078
079    /**
080     *  <p>Name of the Product the Line Item is based on.</p>
081     * @return lineItem
082     */
083    @NotNull
084    @Valid
085    @JsonProperty("lineItem")
086    public LocalizedString getLineItem();
087
088    /**
089     *  <p><code>sku</code> or <code>key</code> of the updated ProductVariant.</p>
090     * @return variant
091     */
092    @NotNull
093    @JsonProperty("variant")
094    public String getVariant();
095
096    /**
097     * set change
098     * @param change value to be set
099     */
100
101    public void setChange(final String change);
102
103    /**
104     *  <p>Value before the change.</p>
105     * @param previousValue value to be set
106     */
107
108    public void setPreviousValue(final Reference previousValue);
109
110    /**
111     *  <p>Value after the change.</p>
112     * @param nextValue value to be set
113     */
114
115    public void setNextValue(final Reference nextValue);
116
117    /**
118     *  <p>Name of the Product the Line Item is based on.</p>
119     * @param lineItem value to be set
120     */
121
122    public void setLineItem(final LocalizedString lineItem);
123
124    /**
125     *  <p><code>sku</code> or <code>key</code> of the updated ProductVariant.</p>
126     * @param variant value to be set
127     */
128
129    public void setVariant(final String variant);
130
131    /**
132     * factory method
133     * @return instance of SetLineItemDistributionChannelChange
134     */
135    public static SetLineItemDistributionChannelChange of() {
136        return new SetLineItemDistributionChannelChangeImpl();
137    }
138
139    /**
140     * factory method to create a shallow copy SetLineItemDistributionChannelChange
141     * @param template instance to be copied
142     * @return copy instance
143     */
144    public static SetLineItemDistributionChannelChange of(final SetLineItemDistributionChannelChange template) {
145        SetLineItemDistributionChannelChangeImpl instance = new SetLineItemDistributionChannelChangeImpl();
146        instance.setChange(template.getChange());
147        instance.setPreviousValue(template.getPreviousValue());
148        instance.setNextValue(template.getNextValue());
149        instance.setLineItem(template.getLineItem());
150        instance.setVariant(template.getVariant());
151        return instance;
152    }
153
154    /**
155     * factory method to create a deep copy of SetLineItemDistributionChannelChange
156     * @param template instance to be copied
157     * @return copy instance
158     */
159    @Nullable
160    public static SetLineItemDistributionChannelChange deepCopy(
161            @Nullable final SetLineItemDistributionChannelChange template) {
162        if (template == null) {
163            return null;
164        }
165        SetLineItemDistributionChannelChangeImpl instance = new SetLineItemDistributionChannelChangeImpl();
166        instance.setChange(template.getChange());
167        instance.setPreviousValue(
168            com.commercetools.history.models.common.Reference.deepCopy(template.getPreviousValue()));
169        instance.setNextValue(com.commercetools.history.models.common.Reference.deepCopy(template.getNextValue()));
170        instance.setLineItem(com.commercetools.history.models.common.LocalizedString.deepCopy(template.getLineItem()));
171        instance.setVariant(template.getVariant());
172        return instance;
173    }
174
175    /**
176     * builder factory method for SetLineItemDistributionChannelChange
177     * @return builder
178     */
179    public static SetLineItemDistributionChannelChangeBuilder builder() {
180        return SetLineItemDistributionChannelChangeBuilder.of();
181    }
182
183    /**
184     * create builder for SetLineItemDistributionChannelChange instance
185     * @param template instance with prefilled values for the builder
186     * @return builder
187     */
188    public static SetLineItemDistributionChannelChangeBuilder builder(
189            final SetLineItemDistributionChannelChange template) {
190        return SetLineItemDistributionChannelChangeBuilder.of(template);
191    }
192
193    /**
194     * accessor map function
195     * @param <T> mapped type
196     * @param helper function to map the object
197     * @return mapped value
198     */
199    default <T> T withSetLineItemDistributionChannelChange(Function<SetLineItemDistributionChannelChange, T> helper) {
200        return helper.apply(this);
201    }
202
203    /**
204     * gives a TypeReference for usage with Jackson DataBind
205     * @return TypeReference
206     */
207    public static com.fasterxml.jackson.core.type.TypeReference<SetLineItemDistributionChannelChange> typeReference() {
208        return new com.fasterxml.jackson.core.type.TypeReference<SetLineItemDistributionChannelChange>() {
209            @Override
210            public String toString() {
211                return "TypeReference<SetLineItemDistributionChannelChange>";
212            }
213        };
214    }
215}