io.sphere.sdk.products

Class ProductDraftDsl

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.products.ProductDraftDsl

All Implemented Interfaces:

MetaAttributes, WithKey, WithLocalizedSlug, ProductDraft

@Generated(value="io.sphere.sdk.annotations.processors.generators.ResourceDraftValueGenerator",
           comments="Generated from: io.sphere.sdk.products.ProductDraft")
public final class ProductDraftDsl
extends Base
implements ProductDraft

Dsl class for ProductDraft.

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.
ProductDraftBuilder	newBuilder() Creates a new builder with the values of this object.
static ProductDraftDsl	of(ProductDraft template) Creates a new object initialized with the fields of the template parameter.
static ProductDraftDsl	of(ResourceIdentifier<ProductType> productType, LocalizedString name, LocalizedString slug, ProductVariantDraft masterVariant) Creates a new object initialized with the given values.
ProductDraftDsl	withCategories(Set<ResourceIdentifier<Category>> categories)
ProductDraftDsl	withCategoryOrderHints(CategoryOrderHints categoryOrderHints)
ProductDraftDsl	withDescription(LocalizedString description)
ProductDraftDsl	withKey(String key)
ProductDraftDsl	withMasterVariant(ProductVariantDraft masterVariant)
ProductDraftDsl	withMetaDescription(LocalizedString metaDescription)
ProductDraftDsl	withMetaKeywords(LocalizedString metaKeywords)
ProductDraftDsl	withMetaTitle(LocalizedString metaTitle)
ProductDraftDsl	withName(LocalizedString name)
ProductDraftDsl	withProductType(ResourceIdentifier<ProductType> productType)
ProductDraftDsl	withPublish(Boolean publish)
ProductDraftDsl	withSearchKeywords(SearchKeywords searchKeywords)
ProductDraftDsl	withSlug(LocalizedString slug)
ProductDraftDsl	withState(ResourceIdentifier<State> state)
ProductDraftDsl	withTaxCategory(ResourceIdentifier<TaxCategory> taxCategory)
ProductDraftDsl	withVariants(List<ProductVariantDraft> variants)

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

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

metaAttributesOf, metaAttributesOf

Method Detail

getCategories

public Set<ResourceIdentifier<Category>> getCategories()

Specified by:

getCategories in interface ProductDraft

getCategoryOrderHints

@Nullable
public CategoryOrderHints getCategoryOrderHints()

Specified by:

getCategoryOrderHints in interface ProductDraft

getDescription

@Nullable
public LocalizedString getDescription()

Specified by:

getDescription in interface ProductDraft

getKey

@Nullable
public String getKey()

Specified by:

getKey in interface WithKey

Specified by:

getKey in interface ProductDraft

getMasterVariant

@Nullable
public ProductVariantDraft getMasterVariant()

Specified by:

getMasterVariant in interface ProductDraft

getMetaDescription

@Nullable
public LocalizedString getMetaDescription()

Specified by:

getMetaDescription in interface MetaAttributes

Specified by:

getMetaDescription in interface ProductDraft

getMetaKeywords

@Nullable
public LocalizedString getMetaKeywords()

Specified by:

getMetaKeywords in interface MetaAttributes

Specified by:

getMetaKeywords in interface ProductDraft

getMetaTitle

@Nullable
public LocalizedString getMetaTitle()

Specified by:

getMetaTitle in interface MetaAttributes

Specified by:

getMetaTitle in interface ProductDraft

getName

public LocalizedString getName()

Specified by:

getName in interface ProductDraft

getProductType

public ResourceIdentifier<ProductType> getProductType()

Specified by:

getProductType in interface ProductDraft

isPublish

@Nullable
public Boolean isPublish()

Description copied from interface: ProductDraft

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.

Specified by:

isPublish in interface ProductDraft

Returns:

true if product should be published

getSearchKeywords

public SearchKeywords getSearchKeywords()

Specified by:

getSearchKeywords in interface ProductDraft

getSlug

public LocalizedString getSlug()

Specified by:

getSlug in interface WithLocalizedSlug

Specified by:

getSlug in interface ProductDraft

getState

@Nullable
public ResourceIdentifier<State> getState()

Specified by:

getState in interface ProductDraft

getTaxCategory

@Nullable
public ResourceIdentifier<TaxCategory> getTaxCategory()

Specified by:

getTaxCategory in interface ProductDraft

getVariants

public List<ProductVariantDraft> getVariants()

Specified by:

getVariants in interface ProductDraft

newBuilder

public ProductDraftBuilder newBuilder()

Creates a new builder with the values of this object.

Returns:

new builder

withCategories

public ProductDraftDsl withCategories(Set<ResourceIdentifier<Category>> categories)

withCategoryOrderHints

public ProductDraftDsl withCategoryOrderHints(@Nullable
                                              CategoryOrderHints categoryOrderHints)

withDescription

public ProductDraftDsl withDescription(@Nullable
                                       LocalizedString description)

withKey

public ProductDraftDsl withKey(@Nullable
                               String key)

withMasterVariant

public ProductDraftDsl withMasterVariant(@Nullable
                                         ProductVariantDraft masterVariant)

withMetaDescription

public ProductDraftDsl withMetaDescription(@Nullable
                                           LocalizedString metaDescription)

withMetaKeywords

public ProductDraftDsl withMetaKeywords(@Nullable
                                        LocalizedString metaKeywords)

withMetaTitle

public ProductDraftDsl withMetaTitle(@Nullable
                                     LocalizedString metaTitle)

withName

public ProductDraftDsl withName(LocalizedString name)

withProductType

public ProductDraftDsl withProductType(ResourceIdentifier<ProductType> productType)

withPublish

public ProductDraftDsl withPublish(@Nullable
                                   Boolean publish)

withSearchKeywords

public ProductDraftDsl withSearchKeywords(SearchKeywords searchKeywords)

withSlug

public ProductDraftDsl withSlug(LocalizedString slug)

withState

public ProductDraftDsl withState(@Nullable
                                 ResourceIdentifier<State> state)

withTaxCategory

public ProductDraftDsl withTaxCategory(@Nullable
                                       ResourceIdentifier<TaxCategory> taxCategory)

withVariants

public ProductDraftDsl withVariants(List<ProductVariantDraft> variants)

of

public static ProductDraftDsl of(ResourceIdentifier<ProductType> productType,
                                 LocalizedString name,
                                 LocalizedString slug,
                                 @Nullable
                                 ProductVariantDraft masterVariant)

Creates a new object initialized with the given values.

Parameters:

productType - initial value for the ProductDraft.getProductType() property

name - initial value for the ProductDraft.getName() property

slug - initial value for the ProductDraft.getSlug() property

masterVariant - initial value for the ProductDraft.getMasterVariant() property

Returns:

new object initialized with the given values

of

public static ProductDraftDsl of(ProductDraft template)

Creates a new object initialized with the fields of the template parameter.

Parameters:

template - the template

Returns:

a new object initialized from the template