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