com.commercetools.history.models.change.SetParcelTrackingDataChange Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commercetools-sdk-java-history Show documentation
The e-commerce SDK from commercetools Composable Commerce for Java
There is a newer version: 17.15.1
Show newest version

package com.commercetools.history.models.change;

import java.time.*;
import java.util.*;
import java.util.function.Function;

import javax.annotation.Nullable;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;

import com.commercetools.history.models.change_value.ParcelChangeValue;
import com.commercetools.history.models.common.TrackingData;
import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.annotation.*;

import io.vrap.rmf.base.client.utils.Generated;

/**
 *  Change triggered by the following update actions:
 *  
 *   Set Parcel Tracking Data on Orders.
 *   Set Parcel Tracking Data on Staged Orders.
 *  
 *
 * 
 * Example to create an instance using the builder pattern
 * 
 * 
 *     SetParcelTrackingDataChange setParcelTrackingDataChange = SetParcelTrackingDataChange.builder()
 *             .change("{change}")
 *             .previousValue(previousValueBuilder -> previousValueBuilder)
 *             .nextValue(nextValueBuilder -> nextValueBuilder)
 *             .parcel(parcelBuilder -> parcelBuilder)
 *             .build()
 * 
 * 
 */
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = SetParcelTrackingDataChangeImpl.class)
public interface SetParcelTrackingDataChange extends Change {

    /**
     * discriminator value for SetParcelTrackingDataChange
     */
    String SET_PARCEL_TRACKING_DATA_CHANGE = "SetParcelTrackingDataChange";

    /**
     *
     * @return type
     */
    @NotNull
    @JsonProperty("type")
    public String getType();

    /**
     *
     * @return change
     */
    @NotNull
    @JsonProperty("change")
    public String getChange();

    /**
     *  Value before the change.
     * @return previousValue
     */
    @NotNull
    @Valid
    @JsonProperty("previousValue")
    public TrackingData getPreviousValue();

    /**
     *  Value after the change.
     * @return nextValue
     */
    @NotNull
    @Valid
    @JsonProperty("nextValue")
    public TrackingData getNextValue();

    /**
     *  Information about the updated Parcel.
     * @return parcel
     */
    @NotNull
    @Valid
    @JsonProperty("parcel")
    public ParcelChangeValue getParcel();

    /**
     * set change
     * @param change value to be set
     */

    public void setChange(final String change);

    /**
     *  Value before the change.
     * @param previousValue value to be set
     */

    public void setPreviousValue(final TrackingData previousValue);

    /**
     *  Value after the change.
     * @param nextValue value to be set
     */

    public void setNextValue(final TrackingData nextValue);

    /**
     *  Information about the updated Parcel.
     * @param parcel value to be set
     */

    public void setParcel(final ParcelChangeValue parcel);

    /**
     * factory method
     * @return instance of SetParcelTrackingDataChange
     */
    public static SetParcelTrackingDataChange of() {
        return new SetParcelTrackingDataChangeImpl();
    }

    /**
     * factory method to create a shallow copy SetParcelTrackingDataChange
     * @param template instance to be copied
     * @return copy instance
     */
    public static SetParcelTrackingDataChange of(final SetParcelTrackingDataChange template) {
        SetParcelTrackingDataChangeImpl instance = new SetParcelTrackingDataChangeImpl();
        instance.setChange(template.getChange());
        instance.setPreviousValue(template.getPreviousValue());
        instance.setNextValue(template.getNextValue());
        instance.setParcel(template.getParcel());
        return instance;
    }

    /**
     * factory method to create a deep copy of SetParcelTrackingDataChange
     * @param template instance to be copied
     * @return copy instance
     */
    @Nullable
    public static SetParcelTrackingDataChange deepCopy(@Nullable final SetParcelTrackingDataChange template) {
        if (template == null) {
            return null;
        }
        SetParcelTrackingDataChangeImpl instance = new SetParcelTrackingDataChangeImpl();
        instance.setChange(template.getChange());
        instance.setPreviousValue(
            com.commercetools.history.models.common.TrackingData.deepCopy(template.getPreviousValue()));
        instance.setNextValue(com.commercetools.history.models.common.TrackingData.deepCopy(template.getNextValue()));
        instance.setParcel(
            com.commercetools.history.models.change_value.ParcelChangeValue.deepCopy(template.getParcel()));
        return instance;
    }

    /**
     * builder factory method for SetParcelTrackingDataChange
     * @return builder
     */
    public static SetParcelTrackingDataChangeBuilder builder() {
        return SetParcelTrackingDataChangeBuilder.of();
    }

    /**
     * create builder for SetParcelTrackingDataChange instance
     * @param template instance with prefilled values for the builder
     * @return builder
     */
    public static SetParcelTrackingDataChangeBuilder builder(final SetParcelTrackingDataChange template) {
        return SetParcelTrackingDataChangeBuilder.of(template);
    }

    /**
     * accessor map function
     * @param  mapped type
     * @param helper function to map the object
     * @return mapped value
     */
    default  T withSetParcelTrackingDataChange(Function helper) {
        return helper.apply(this);
    }

    /**
     * gives a TypeReference for usage with Jackson DataBind
     * @return TypeReference
     */
    public static com.fasterxml.jackson.core.type.TypeReference typeReference() {
        return new com.fasterxml.jackson.core.type.TypeReference() {
            @Override
            public String toString() {
                return "TypeReference";
            }
        };
    }
}