Package com.commercetools.history.models.change

Interface SetReturnItemLineItemCustomFieldChange

All Superinterfaces:
Change
public interface SetReturnItemLineItemCustomFieldChange extends Change

Change triggered by the Set ReturnItem CustomField update action.

Example to create an instance using the builder pattern 

     SetReturnItemLineItemCustomFieldChange setReturnItemLineItemCustomFieldChange = SetReturnItemLineItemCustomFieldChange.builder()
             .change("{change}")
             .variant("{variant}")
             .lineItem(lineItemBuilder -> lineItemBuilder)
             .lineItemId("{lineItemId}")
             .name("{name}")
             .customTypeId("{customTypeId}")
             .build()

  • Field Details

    • SET_RETURN_ITEM_LINE_ITEM_CUSTOM_FIELD_CHANGE

      static final String SET_RETURN_ITEM_LINE_ITEM_CUSTOM_FIELD_CHANGE
      discriminator value for SetReturnItemLineItemCustomFieldChange
      See Also:

  • Method Details

    • getChange

      @NotNull @NotNull String getChange()
      Description copied from interface: Change

      Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

      Records can be filtered by this value using the changes query parameter.

      Specified by:
      getChange in interface Change
      Returns:
      change

    • getType

      @NotNull @NotNull String getType()
      Description copied from interface: Change

      Unique discriminator value to reliably deserialize the data type.

      Specified by:
      getType in interface Change
      Returns:
      type

    • getVariant

      @NotNull @NotNull String getVariant()

      Identifier of the updated Product Variant.

      This field holds the SKU, if defined; otherwise the key; otherwise the ID.

      Returns:
      variant

    • getLineItem

      @NotNull @Valid @NotNull @Valid LocalizedString getLineItem()

      Name of the Product the updated Line Item is based on.

      Returns:
      lineItem

    • getLineItemId

      @NotNull @NotNull String getLineItemId()

      id of the updated LineItem.

      Returns:
      lineItemId

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field.

      Returns:
      name

    • getCustomTypeId

      @NotNull @NotNull String getCustomTypeId()

      id of the referenced Type.

      Returns:
      customTypeId

    • getPreviousValue

      @NotNull @NotNull Object getPreviousValue()

      Value before the change.

      Returns:
      previousValue

    • getNextValue

      @NotNull @NotNull Object getNextValue()

      Value after the change.

      Returns:
      nextValue

    • setChange

      void setChange(String change)
      set change
      Specified by:
      setChange in interface Change
      Parameters:
      change - value to be set

    • setVariant

      void setVariant(String variant)

      Identifier of the updated Product Variant.

      This field holds the SKU, if defined; otherwise the key; otherwise the ID.

      Parameters:
      variant - value to be set

    • setLineItem

      void setLineItem(LocalizedString lineItem)

      Name of the Product the updated Line Item is based on.

      Parameters:
      lineItem - value to be set

    • setLineItemId

      void setLineItemId(String lineItemId)

      id of the updated LineItem.

      Parameters:
      lineItemId - value to be set

    • setName

      void setName(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set

    • setCustomTypeId

      void setCustomTypeId(String customTypeId)

      id of the referenced Type.

      Parameters:
      customTypeId - value to be set

    • setPreviousValue

      void setPreviousValue(Object previousValue)

      Value before the change.

      Parameters:
      previousValue - value to be set

    • setNextValue

      void setNextValue(Object nextValue)

      Value after the change.

      Parameters:
      nextValue - value to be set

    • of

      static SetReturnItemLineItemCustomFieldChange of()
      factory method
      Returns:
      instance of SetReturnItemLineItemCustomFieldChange

    • of

      static SetReturnItemLineItemCustomFieldChange of(SetReturnItemLineItemCustomFieldChange template)
      factory method to create a shallow copy SetReturnItemLineItemCustomFieldChange
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      SetReturnItemLineItemCustomFieldChange copyDeep()
      Specified by:
      copyDeep in interface Change

    • deepCopy

      @Nullable static SetReturnItemLineItemCustomFieldChange deepCopy(@Nullable SetReturnItemLineItemCustomFieldChange template)
      factory method to create a deep copy of SetReturnItemLineItemCustomFieldChange
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static SetReturnItemLineItemCustomFieldChangeBuilder builder()
      builder factory method for SetReturnItemLineItemCustomFieldChange
      Returns:
      builder

    • builder

      static SetReturnItemLineItemCustomFieldChangeBuilder builder(SetReturnItemLineItemCustomFieldChange template)
      create builder for SetReturnItemLineItemCustomFieldChange instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withSetReturnItemLineItemCustomFieldChange

      default <T> T withSetReturnItemLineItemCustomFieldChange(Function<SetReturnItemLineItemCustomFieldChange,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<SetReturnItemLineItemCustomFieldChange> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference