Package com.commercetools.api.models.variant

Interface VariantChangeAssetOrderAction

All Superinterfaces:
VariantUpdateAction
public interface VariantChangeAssetOrderAction extends VariantUpdateAction

Changes the order of Assets on a Variant.

Example to create an instance using the builder pattern 

     VariantChangeAssetOrderAction variantChangeAssetOrderAction = VariantChangeAssetOrderAction.builder()
             .plusAssetOrder(assetOrderBuilder -> assetOrderBuilder)
             .build()

  • Field Details

    • CHANGE_ASSET_ORDER

      static final String CHANGE_ASSET_ORDER
      discriminator value for VariantChangeAssetOrderAction
      See Also:

  • Method Details

    • getStaged

      Boolean getStaged()

      If true, only the staged assets is updated. If false, both the current and staged assets are updated.

      Returns:
      staged

    • getAssetOrder

      @NotNull @NotNull List<String> getAssetOrder()

      All existing Asset ids of the Variant in the desired new order.

      Returns:
      assetOrder

    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged assets is updated. If false, both the current and staged assets are updated.

      Parameters:
      staged - value to be set

    • setAssetOrder

      void setAssetOrder(String... assetOrder)

      All existing Asset ids of the Variant in the desired new order.

      Parameters:
      assetOrder - values to be set

    • setAssetOrder

      void setAssetOrder(List<String> assetOrder)

      All existing Asset ids of the Variant in the desired new order.

      Parameters:
      assetOrder - values to be set

    • of

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

    • of

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

    • copyDeep

      VariantChangeAssetOrderAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantChangeAssetOrderActionBuilder builder()
      builder factory method for VariantChangeAssetOrderAction
      Returns:
      builder

    • builder

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

    • withVariantChangeAssetOrderAction

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

    • typeReference

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