001
002package com.commercetools.api.models.product_discount;
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.LocalizedString;
012import com.fasterxml.jackson.annotation.*;
013import com.fasterxml.jackson.databind.annotation.*;
014
015import io.vrap.rmf.base.client.utils.Generated;
016
017/**
018 * ProductDiscountSetDescriptionAction
019 *
020 * <hr>
021 * Example to create an instance using the builder pattern
022 * <div class=code-example>
023 * <pre><code class='java'>
024 *     ProductDiscountSetDescriptionAction productDiscountSetDescriptionAction = ProductDiscountSetDescriptionAction.builder()
025 *             .build()
026 * </code></pre>
027 * </div>
028 */
029@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
030@JsonDeserialize(as = ProductDiscountSetDescriptionActionImpl.class)
031public interface ProductDiscountSetDescriptionAction extends ProductDiscountUpdateAction {
032
033    /**
034     * discriminator value for ProductDiscountSetDescriptionAction
035     */
036    String SET_DESCRIPTION = "setDescription";
037
038    /**
039     *  <p>Value to set. If empty, any existing value will be removed.</p>
040     * @return description
041     */
042    @Valid
043    @JsonProperty("description")
044    public LocalizedString getDescription();
045
046    /**
047     *  <p>Value to set. If empty, any existing value will be removed.</p>
048     * @param description value to be set
049     */
050
051    public void setDescription(final LocalizedString description);
052
053    /**
054     * factory method
055     * @return instance of ProductDiscountSetDescriptionAction
056     */
057    public static ProductDiscountSetDescriptionAction of() {
058        return new ProductDiscountSetDescriptionActionImpl();
059    }
060
061    /**
062     * factory method to create a shallow copy ProductDiscountSetDescriptionAction
063     * @param template instance to be copied
064     * @return copy instance
065     */
066    public static ProductDiscountSetDescriptionAction of(final ProductDiscountSetDescriptionAction template) {
067        ProductDiscountSetDescriptionActionImpl instance = new ProductDiscountSetDescriptionActionImpl();
068        instance.setDescription(template.getDescription());
069        return instance;
070    }
071
072    /**
073     * factory method to create a deep copy of ProductDiscountSetDescriptionAction
074     * @param template instance to be copied
075     * @return copy instance
076     */
077    @Nullable
078    public static ProductDiscountSetDescriptionAction deepCopy(
079            @Nullable final ProductDiscountSetDescriptionAction template) {
080        if (template == null) {
081            return null;
082        }
083        ProductDiscountSetDescriptionActionImpl instance = new ProductDiscountSetDescriptionActionImpl();
084        instance.setDescription(
085            com.commercetools.api.models.common.LocalizedString.deepCopy(template.getDescription()));
086        return instance;
087    }
088
089    /**
090     * builder factory method for ProductDiscountSetDescriptionAction
091     * @return builder
092     */
093    public static ProductDiscountSetDescriptionActionBuilder builder() {
094        return ProductDiscountSetDescriptionActionBuilder.of();
095    }
096
097    /**
098     * create builder for ProductDiscountSetDescriptionAction instance
099     * @param template instance with prefilled values for the builder
100     * @return builder
101     */
102    public static ProductDiscountSetDescriptionActionBuilder builder(
103            final ProductDiscountSetDescriptionAction template) {
104        return ProductDiscountSetDescriptionActionBuilder.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 withProductDiscountSetDescriptionAction(Function<ProductDiscountSetDescriptionAction, 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<ProductDiscountSetDescriptionAction> typeReference() {
122        return new com.fasterxml.jackson.core.type.TypeReference<ProductDiscountSetDescriptionAction>() {
123            @Override
124            public String toString() {
125                return "TypeReference<ProductDiscountSetDescriptionAction>";
126            }
127        };
128    }
129}