io.sphere.sdk.products.ProductVariant Maven / Gradle / Ivy

Go to download
package io.sphere.sdk.products;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

import javax.annotation.Nullable;
import java.util.List;

@JsonDeserialize(as = ProductVariantImpl.class)
public interface ProductVariant extends AttributeContainer {
    Integer getId();

    @Nullable
    String getSku();

    List getPrices();

    List getImages();

    /**
     * The availability is set if the variant is tracked by the inventory. The field might not contain the latest
     * inventory state (it is eventually consistent) and can be used as an optimization to reduce calls to the inventory service.
     * Notice that availability is not set when using the ProductProjection Search endpoint.
     *
     * @return availability
     */
    @Nullable
    ProductVariantAvailability getAvailability();

    /**
     * A flag that indicates whether the variant matches the search criteria used when requesting the list of products or not.
     * This flag is needed since all products that have at least one matching variant will be returned, along with all its
     * variants, even those that do not match the search request themselves.
     * Notice that this flag is only set when using the ProductProjection Search endpoint.
     *
     * @return whether the variant matches the search request parameters
     */
    @Nullable
    Boolean isMatchingVariant();

    /**
     * Gets the id of the product and the variant. This operation may not be available.
     * It will be available if this {@link ProductVariant} has been created
     * by loading a {@link Product} or a {@link ProductProjection} from JSON.
     * @return identifier for this variant
     * @throws UnsupportedOperationException if the operation is not available
     */
    VariantIdentifier getIdentifier();
}