io.sphere.sdk.products.commands.updateactions

Class SetProductVariantKey

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.products.commands.updateactions.SetProductVariantKey

All Implemented Interfaces:

UpdateAction<Product>

public final class SetProductVariantKey
extends UpdateActionImpl<T>

Changes the key of a ProductVariant, for Products use SetKey.

See also ProductUpdateCommand.

Use the variantId to select the variant

final String key = randomKey();
withProduct(client(), (Product product) -> {
    assertThat(product.getMasterData().hasStagedChanges()).isFalse();
    final Integer variantId = product.getMasterData().getStaged().getMasterVariant().getId();
    final ProductUpdateCommand cmd =
            ProductUpdateCommand.of(product, SetProductVariantKey.ofKeyAndVariantId(key, variantId));
    final Product updatedProduct = client().executeBlocking(cmd);
    assertThat(updatedProduct.getMasterData().getStaged().getMasterVariant().getKey()).isEqualTo(key);
    assertThat(updatedProduct.getKey()).isNotEqualTo(key);
    assertThat(updatedProduct.getMasterData().hasStagedChanges()).isTrue();
});
See the test code.

or use the sku to select the variant

final String key = randomKey();
withProduct(client(), (Product product) -> {
    assertThat(product.getMasterData().hasStagedChanges()).isFalse();
    final String sku = product.getMasterData().getStaged().getMasterVariant().getSku();
    final ProductUpdateCommand cmd =
            ProductUpdateCommand.of(product, SetProductVariantKey.ofKeyAndSku(key, sku));
    final Product updatedProduct = client().executeBlocking(cmd);
    assertThat(updatedProduct.getMasterData().getStaged().getMasterVariant().getKey()).isEqualTo(key);
    assertThat(updatedProduct.getKey()).isNotEqualTo(key);
    assertThat(updatedProduct.getMasterData().hasStagedChanges()).isTrue();
});
See the test code.

See Also:

ProductVariant.getKey()

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	staged

Method Summary

Modifier and Type	Method and Description
String	getKey()
String	getSku()
Integer	getVariantId()
Boolean	isStaged()
static SetProductVariantKey	ofKeyAndSku(String key, String sku)
static SetProductVariantKey	ofKeyAndSku(String key, String sku, Boolean staged)
static SetProductVariantKey	ofKeyAndVariantId(String key, Integer variantId)
static SetProductVariantKey	ofKeyAndVariantId(String key, Integer variantId, 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

getKey

@Nullable
public String getKey()

getVariantId

@Nullable
public Integer getVariantId()

getSku

@Nullable
public String getSku()

ofKeyAndVariantId

public static SetProductVariantKey ofKeyAndVariantId(@Nullable
                                                     String key,
                                                     @Nonnull
                                                     Integer variantId)

ofKeyAndVariantId

public static SetProductVariantKey ofKeyAndVariantId(@Nullable
                                                     String key,
                                                     @Nonnull
                                                     Integer variantId,
                                                     @Nullable
                                                     Boolean staged)

ofKeyAndSku

public static SetProductVariantKey ofKeyAndSku(@Nullable
                                               String key,
                                               @Nonnull
                                               String sku)

ofKeyAndSku

public static SetProductVariantKey ofKeyAndSku(@Nullable
                                               String key,
                                               @Nonnull
                                               String sku,
                                               @Nullable
                                               Boolean staged)

isStaged

@Nullable
public Boolean isStaged()