001
002package com.commercetools.history.models.common;
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.fasterxml.jackson.annotation.*;
013import com.fasterxml.jackson.databind.annotation.*;
014
015import io.vrap.rmf.base.client.utils.Generated;
016
017/**
018 * ProductVariantAvailability
019 *
020 * <hr>
021 * Example to create an instance using the builder pattern
022 * <div class=code-example>
023 * <pre><code class='java'>
024 *     ProductVariantAvailability productVariantAvailability = ProductVariantAvailability.builder()
025 *             .isOnStock(true)
026 *             .restockableInDays(1)
027 *             .availableQuantity(1)
028 *             .channels(channelsBuilder -> channelsBuilder)
029 *             .build()
030 * </code></pre>
031 * </div>
032 */
033@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
034@JsonDeserialize(as = ProductVariantAvailabilityImpl.class)
035public interface ProductVariantAvailability {
036
037    /**
038     *
039     * @return isOnStock
040     */
041    @NotNull
042    @JsonProperty("isOnStock")
043    public Boolean getIsOnStock();
044
045    /**
046     *
047     * @return restockableInDays
048     */
049    @NotNull
050    @JsonProperty("restockableInDays")
051    public Integer getRestockableInDays();
052
053    /**
054     *
055     * @return availableQuantity
056     */
057    @NotNull
058    @JsonProperty("availableQuantity")
059    public Integer getAvailableQuantity();
060
061    /**
062     *
063     * @return channels
064     */
065    @NotNull
066    @Valid
067    @JsonProperty("channels")
068    public ProductVariantChannelAvailabilityMap getChannels();
069
070    /**
071     * set isOnStock
072     * @param isOnStock value to be set
073     */
074
075    public void setIsOnStock(final Boolean isOnStock);
076
077    /**
078     * set restockableInDays
079     * @param restockableInDays value to be set
080     */
081
082    public void setRestockableInDays(final Integer restockableInDays);
083
084    /**
085     * set availableQuantity
086     * @param availableQuantity value to be set
087     */
088
089    public void setAvailableQuantity(final Integer availableQuantity);
090
091    /**
092     * set channels
093     * @param channels value to be set
094     */
095
096    public void setChannels(final ProductVariantChannelAvailabilityMap channels);
097
098    /**
099     * factory method
100     * @return instance of ProductVariantAvailability
101     */
102    public static ProductVariantAvailability of() {
103        return new ProductVariantAvailabilityImpl();
104    }
105
106    /**
107     * factory method to create a shallow copy ProductVariantAvailability
108     * @param template instance to be copied
109     * @return copy instance
110     */
111    public static ProductVariantAvailability of(final ProductVariantAvailability template) {
112        ProductVariantAvailabilityImpl instance = new ProductVariantAvailabilityImpl();
113        instance.setIsOnStock(template.getIsOnStock());
114        instance.setRestockableInDays(template.getRestockableInDays());
115        instance.setAvailableQuantity(template.getAvailableQuantity());
116        instance.setChannels(template.getChannels());
117        return instance;
118    }
119
120    /**
121     * factory method to create a deep copy of ProductVariantAvailability
122     * @param template instance to be copied
123     * @return copy instance
124     */
125    @Nullable
126    public static ProductVariantAvailability deepCopy(@Nullable final ProductVariantAvailability template) {
127        if (template == null) {
128            return null;
129        }
130        ProductVariantAvailabilityImpl instance = new ProductVariantAvailabilityImpl();
131        instance.setIsOnStock(template.getIsOnStock());
132        instance.setRestockableInDays(template.getRestockableInDays());
133        instance.setAvailableQuantity(template.getAvailableQuantity());
134        instance.setChannels(com.commercetools.history.models.common.ProductVariantChannelAvailabilityMap
135                .deepCopy(template.getChannels()));
136        return instance;
137    }
138
139    /**
140     * builder factory method for ProductVariantAvailability
141     * @return builder
142     */
143    public static ProductVariantAvailabilityBuilder builder() {
144        return ProductVariantAvailabilityBuilder.of();
145    }
146
147    /**
148     * create builder for ProductVariantAvailability instance
149     * @param template instance with prefilled values for the builder
150     * @return builder
151     */
152    public static ProductVariantAvailabilityBuilder builder(final ProductVariantAvailability template) {
153        return ProductVariantAvailabilityBuilder.of(template);
154    }
155
156    /**
157     * accessor map function
158     * @param <T> mapped type
159     * @param helper function to map the object
160     * @return mapped value
161     */
162    default <T> T withProductVariantAvailability(Function<ProductVariantAvailability, T> helper) {
163        return helper.apply(this);
164    }
165
166    /**
167     * gives a TypeReference for usage with Jackson DataBind
168     * @return TypeReference
169     */
170    public static com.fasterxml.jackson.core.type.TypeReference<ProductVariantAvailability> typeReference() {
171        return new com.fasterxml.jackson.core.type.TypeReference<ProductVariantAvailability>() {
172            @Override
173            public String toString() {
174                return "TypeReference<ProductVariantAvailability>";
175            }
176        };
177    }
178}