io.sphere.sdk.products.commands.updateactions

Class AddExternalImage

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.UpdateActionImpl<T>

io.sphere.sdk.products.commands.updateactions.AddExternalImage

All Implemented Interfaces:

UpdateAction<Product>

public final class AddExternalImage
extends UpdateActionImpl<T>

Adds external image url with meta-information to the product variant.

See also ProductUpdateCommand.

By variant ID (every variant has a variantId):

withUpdateableProduct(client(), (Product product) -> {
    assertThat(product.getMasterData().getStaged().getMasterVariant().getImages()).hasSize(0);
    assertThat(product.getMasterData().hasStagedChanges()).isFalse();

    final Image image = createExternalImage();
    final Product updatedProduct = client().executeBlocking(ProductUpdateCommand.of(product, AddExternalImage.ofVariantId(MASTER_VARIANT_ID, image)));

    assertThat(updatedProduct.getMasterData().getStaged().getMasterVariant().getImages()).isEqualTo(asList(image));
    assertThat(updatedProduct.getMasterData().hasStagedChanges()).isTrue();
    return updatedProduct;
});
See the test code.

By SKU (attention, SKU is optional field in a variant):

withUpdateableProduct(client(), (Product product) -> {
    final ProductVariant masterVariant = product.getMasterData().getStaged().getMasterVariant();
    assertThat(masterVariant.getImages()).hasSize(0);
    assertThat(product.getMasterData().hasStagedChanges()).isFalse();

    final Image image = createExternalImage();
    final Product updatedProduct = client().executeBlocking(ProductUpdateCommand.of(product, AddExternalImage.ofSku(masterVariant.getSku(), image)));

    assertThat(updatedProduct.getMasterData().getStaged().getMasterVariant().getImages()).isEqualTo(asList(image));
    assertThat(updatedProduct.getMasterData().hasStagedChanges()).isTrue();
    return updatedProduct;
});
See the test code.

See Also:

ProductVariant.getImages(), RemoveImage

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	staged

Method Summary

Modifier and Type	Method and Description
Image	getImage()
String	getSku()
Integer	getVariantId()
Boolean	isStaged()
static AddExternalImage	of(Image image, Integer variantId)
static AddExternalImage	ofSku(String sku, Image image)
static AddExternalImage	ofSku(String sku, Image image, Boolean staged)
static AddExternalImage	ofVariantId(Integer variantId, Image image)
static AddExternalImage	ofVariantId(Integer variantId, Image image, Boolean staged)

Methods inherited from class io.sphere.sdk.commands.UpdateActionImpl

getAction

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

staged

@Nullable
protected final Boolean staged

Method Detail

of

public static AddExternalImage of(Image image,
                                  Integer variantId)

ofVariantId

public static AddExternalImage ofVariantId(Integer variantId,
                                           Image image)

ofVariantId

public static AddExternalImage ofVariantId(Integer variantId,
                                           Image image,
                                           @Nullable
                                           Boolean staged)

ofSku

public static AddExternalImage ofSku(String sku,
                                     Image image)

ofSku

public static AddExternalImage ofSku(String sku,
                                     Image image,
                                     @Nullable
                                     Boolean staged)

getImage

public Image getImage()

getVariantId

@Nullable
public Integer getVariantId()

getSku

@Nullable
public String getSku()

isStaged

@Nullable
public Boolean isStaged()