io.sphere.sdk.products.commands.updateactions

Class SetAttributeInAllVariants

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.products.commands.updateactions.SetAttributeInAllVariants

All Implemented Interfaces:

UpdateAction<Product>

public final class SetAttributeInAllVariants
extends UpdateActionImpl<T>

Adds / Removes / Changes a custom attribute in all variants at the same time (it can be helpful to set attribute values that are constrained with SameForAll).

See also ProductUpdateCommand.

withUpdateableProduct(client(), product -> {
    assertThat(product.getMasterData().hasStagedChanges()).isFalse();

    //the setter contains the name and a JSON mapper, declare it only one time in your project per attribute
    //example for MonetaryAmount attribute
    final String moneyAttributeName = MONEY_ATTRIBUTE_NAME;
    final NamedAttributeAccess<MonetaryAmount> moneyAttribute =
            AttributeAccess.ofMoney().ofName(moneyAttributeName);
    final MonetaryAmount newValueForMoney = EURO_10;

    //example for LocalizedEnumValue attribute
    final NamedAttributeAccess<LocalizedEnumValue> colorAttribute = Colors.ATTRIBUTE;
    final LocalizedEnumValue oldValueForColor = Colors.GREEN;
    final LocalizedEnumValue newValueForColor = Colors.RED;

    assertThat(product.getMasterData().getStaged().getMasterVariant().findAttribute(moneyAttribute)).isEmpty();
    assertThat(product.getMasterData().getStaged().getMasterVariant().findAttribute(colorAttribute)).contains(oldValueForColor);

    final SetAttributeInAllVariants moneyUpdate = SetAttributeInAllVariants.of(moneyAttribute, newValueForMoney);
    final SetAttributeInAllVariants localizedEnumUpdate = SetAttributeInAllVariants.of(colorAttribute, newValueForColor);

    final Product updatedProduct = client().executeBlocking(ProductUpdateCommand.of(product, asList(moneyUpdate, localizedEnumUpdate)));
    assertThat(updatedProduct.getMasterData().getStaged().getMasterVariant().findAttribute(moneyAttribute)).contains(newValueForMoney);
    assertThat(updatedProduct.getMasterData().getStaged().getMasterVariant().findAttribute(colorAttribute)).contains(newValueForColor);
    assertThat(updatedProduct.getMasterData().hasStagedChanges()).isTrue();

    final SetAttributeInAllVariants unsetAction = SetAttributeInAllVariants.ofUnsetAttribute(moneyAttribute);
    final Product productWithoutMoney = client().executeBlocking(ProductUpdateCommand.of(updatedProduct, unsetAction));

    assertThat(productWithoutMoney.getMasterData().getStaged().getMasterVariant().findAttribute(moneyAttribute)).isEmpty();

    return productWithoutMoney;
});
See the test code.

See Also:

SetAttribute

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	staged

Method Summary

Modifier and Type	Method and Description
String	getName()
com.fasterxml.jackson.databind.JsonNode	getValue()
Boolean	isStaged()
static SetAttributeInAllVariants	of(AttributeDraft attribute) Action to add/change a custom attribute.
static SetAttributeInAllVariants	of(AttributeDraft attribute, Boolean staged)
static <T> SetAttributeInAllVariants	of(NamedAttributeAccess<T> setter, T value) Action to add/change a custom attribute.
static <T> SetAttributeInAllVariants	of(NamedAttributeAccess<T> setter, T value, Boolean staged)
static SetAttributeInAllVariants	of(String name, com.fasterxml.jackson.databind.JsonNode value) Action to add/remove/change a custom attribute.
static SetAttributeInAllVariants	of(String name, com.fasterxml.jackson.databind.JsonNode value, Boolean staged)
static <T> SetAttributeInAllVariants	ofUnsetAttribute(NamedAttributeAccess<T> NamedAttributeAccess) Action to remove a custom attribute.
static <T> SetAttributeInAllVariants	ofUnsetAttribute(NamedAttributeAccess<T> NamedAttributeAccess, Boolean staged)
static SetAttributeInAllVariants	ofUnsetAttribute(String name) Action to remove a custom attribute.
static SetAttributeInAllVariants	ofUnsetAttribute(String name, 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

getName

public String getName()

getValue

@Nullable
public com.fasterxml.jackson.databind.JsonNode getValue()

of

public static SetAttributeInAllVariants of(String name,
                                           com.fasterxml.jackson.databind.JsonNode value)

Action to add/remove/change a custom attribute.

Parameters:

name - the name of the attribute, consult the product type to find the name

value - embedded in an optional the new value of the attribute or an empty Optional to remove the value from the attribute

Returns:

update action

of

public static SetAttributeInAllVariants of(String name,
                                           com.fasterxml.jackson.databind.JsonNode value,
                                           @Nullable
                                           Boolean staged)

ofUnsetAttribute

public static SetAttributeInAllVariants ofUnsetAttribute(String name)

Action to remove a custom attribute.

Parameters:

name - the name of the attribute, consult the product type to find the name

Returns:

update action

ofUnsetAttribute

public static SetAttributeInAllVariants ofUnsetAttribute(String name,
                                                         @Nullable
                                                         Boolean staged)

ofUnsetAttribute

public static <T> SetAttributeInAllVariants ofUnsetAttribute(NamedAttributeAccess<T> NamedAttributeAccess)

Action to remove a custom attribute.

Type Parameters:

T - type of the attribute

Parameters:

NamedAttributeAccess - object containing the name of the attribute

Returns:

update action

ofUnsetAttribute

public static <T> SetAttributeInAllVariants ofUnsetAttribute(NamedAttributeAccess<T> NamedAttributeAccess,
                                                             @Nullable
                                                             Boolean staged)

of

public static SetAttributeInAllVariants of(AttributeDraft attribute)

Action to add/change a custom attribute.

Parameters:

attribute - the name and the value of the attribute to update

Returns:

update action

of

public static SetAttributeInAllVariants of(AttributeDraft attribute,
                                           @Nullable
                                           Boolean staged)

of

public static <T> SetAttributeInAllVariants of(NamedAttributeAccess<T> setter,
                                               T value)

Action to add/change a custom attribute.

Type Parameters:

T - type of the attribute

Parameters:

setter - the serializer of the attribute

value - the value to set

Returns:

update action

of

public static <T> SetAttributeInAllVariants of(NamedAttributeAccess<T> setter,
                                               T value,
                                               @Nullable
                                               Boolean staged)

isStaged

@Nullable
public Boolean isStaged()