io.sphere.sdk.products

Interface ProductDraft

All Superinterfaces:

MetaAttributes, WithKey, WithLocalizedSlug

All Known Implementing Classes:

ProductDraftDsl

public interface ProductDraft
extends WithLocalizedSlug, MetaAttributes, WithKey

A template for a new Product.

See Also:

ProductDraftBuilder, ProductCreateCommand

Method Summary

Modifier and Type	Method and Description
Set<ResourceIdentifier<Category>>	getCategories()
CategoryOrderHints	getCategoryOrderHints()
LocalizedString	getDescription()
String	getKey()
ProductVariantDraft	getMasterVariant()
LocalizedString	getMetaDescription()
LocalizedString	getMetaKeywords()
LocalizedString	getMetaTitle()
LocalizedString	getName()
ResourceIdentifier<ProductType>	getProductType()
SearchKeywords	getSearchKeywords()
LocalizedString	getSlug()
ResourceIdentifier<State>	getState()
ResourceIdentifier<TaxCategory>	getTaxCategory()
List<ProductVariantDraft>	getVariants()
Boolean	isPublish() Flag for publishing the product immediately.

Methods inherited from interface io.sphere.sdk.models.MetaAttributes

metaAttributesOf, metaAttributesOf

Method Detail

getName

LocalizedString getName()

getProductType

ResourceIdentifier<ProductType> getProductType()

getSlug

LocalizedString getSlug()

Specified by:

getSlug in interface WithLocalizedSlug

getDescription

@Nullable
LocalizedString getDescription()

getCategories

Set<ResourceIdentifier<Category>> getCategories()

getMetaTitle

@Nullable
LocalizedString getMetaTitle()

Specified by:

getMetaTitle in interface MetaAttributes

getMetaDescription

@Nullable
LocalizedString getMetaDescription()

Specified by:

getMetaDescription in interface MetaAttributes

getMetaKeywords

@Nullable
LocalizedString getMetaKeywords()

Specified by:

getMetaKeywords in interface MetaAttributes

getMasterVariant

@Nullable
ProductVariantDraft getMasterVariant()

getVariants

List<ProductVariantDraft> getVariants()

getTaxCategory

@Nullable
ResourceIdentifier<TaxCategory> getTaxCategory()

getSearchKeywords

SearchKeywords getSearchKeywords()

getCategoryOrderHints

@Nullable
CategoryOrderHints getCategoryOrderHints()

getState

@Nullable
ResourceIdentifier<State> getState()

isPublish

@Nullable
Boolean isPublish()

Flag for publishing the product immediately.

withEmptyProductType(client(), randomKey(), productType -> {
    final ProductVariantDraft masterVariant = ProductVariantDraftBuilder.of().build();
    final LocalizedString name = randomSlug();
    final LocalizedString slug = randomSlug();
    final ProductDraft productDraft = ProductDraftBuilder.of(productType, name, slug, masterVariant)
            .publish(true)
            .build();

    final Product product = client().executeBlocking(ProductCreateCommand.of(productDraft));
    assertThat(product.getMasterData().isPublished()).isTrue();
    assertThat(product.getMasterData().getCurrent().getSlug()).isEqualTo(slug);

    try {
        assertEventually(Duration.ofSeconds(120), Duration.ofMillis(200), () -> {
            final ProductProjectionSearch search = ProductProjectionSearch.ofCurrent()
                    .withQueryFilters(m -> m.id().is(product.getId()));
            final PagedSearchResult<ProductProjection> searchResult = client().executeBlocking(search);
            assertThat(searchResult.getResults()).hasSize(1);
        });
    } catch (AssertionError e) {
        logger.error(e.getMessage());
    }

    unpublishAndDelete(product);
});
See the test code.

Returns:

true if product should be published

getKey

@Nullable
String getKey()

Specified by:

getKey in interface WithKey