io.sphere.sdk.products.queries

Interface ProductProjectionByIdGet

All Superinterfaces:

ExpansionPathContainer<ProductProjection>, Get<ProductProjection>, GetDsl<ProductProjection,ProductProjection,ProductProjectionByIdGet>, LocaleSelectionRequestDsl<ProductProjectionByIdGet>, MetaModelGetDsl<ProductProjection,ProductProjection,ProductProjectionByIdGet,ProductProjectionExpansionModel<ProductProjection>>, MetaModelReferenceExpansionDsl<ProductProjection,ProductProjectionByIdGet,ProductProjectionExpansionModel<ProductProjection>>, PriceSelectionRequestDsl<ProductProjectionByIdGet>, ReferenceExpansionDsl<ProductProjection,ProductProjectionByIdGet>, ReferenceExpansionSupport<ProductProjection>, SphereRequest<ProductProjection>, StoreSelectionRequestDsl<ProductProjectionByIdGet>

public interface ProductProjectionByIdGet
extends MetaModelGetDsl<ProductProjection,ProductProjection,ProductProjectionByIdGet,ProductProjectionExpansionModel<ProductProjection>>, PriceSelectionRequestDsl<ProductProjectionByIdGet>, LocaleSelectionRequestDsl<ProductProjectionByIdGet>, StoreSelectionRequestDsl<ProductProjectionByIdGet>

Method Summary

Modifier and Type	Method and Description
List<ExpansionPath<ProductProjection>>	expansionPaths()
static ProductProjectionByIdGet	of(ProductIdentifiable product, ProductProjectionType projectionType)
static ProductProjectionByIdGet	of(String id, ProductProjectionType projectionType)
static ProductProjectionByIdGet	ofCurrent(ProductIdentifiable product)
static ProductProjectionByIdGet	ofCurrent(String id)
static ProductProjectionByIdGet	ofStaged(ProductIdentifiable product)
static ProductProjectionByIdGet	ofStaged(String id)
ProductProjectionByIdGet	plusExpansionPaths(ExpansionPath<ProductProjection> expansionPath) Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.
ProductProjectionByIdGet	withExpansionPaths(ExpansionPath<ProductProjection> expansionPath) Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.
ProductProjectionByIdGet	withExpansionPaths(List<ExpansionPath<ProductProjection>> expansionPaths) Creates a new object with the properties of the old object but replaces all expansion paths with expansionPaths.

Methods inherited from interface io.sphere.sdk.queries.Get

deserialize

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, httpRequestIntent

Methods inherited from interface io.sphere.sdk.expansion.MetaModelReferenceExpansionDsl

plusExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.expansion.ReferenceExpansionDsl

plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths

Methods inherited from interface io.sphere.sdk.products.search.PriceSelectionRequestDsl

getPriceSelection, withPriceSelection

Methods inherited from interface io.sphere.sdk.selection.LocaleSelectionRequestDsl

getLocaleSelection, withLocaleSelection

Methods inherited from interface io.sphere.sdk.selection.StoreSelectionRequestDsl

getStoreSelection, withStoreSelection

Method Detail

of

static ProductProjectionByIdGet of(ProductIdentifiable product,
                                   ProductProjectionType projectionType)

ofCurrent

static ProductProjectionByIdGet ofCurrent(ProductIdentifiable product)

ofStaged

static ProductProjectionByIdGet ofStaged(ProductIdentifiable product)

of

static ProductProjectionByIdGet of(String id,
                                   ProductProjectionType projectionType)

ofStaged

static ProductProjectionByIdGet ofStaged(String id)

ofCurrent

static ProductProjectionByIdGet ofCurrent(String id)

expansionPaths

List<ExpansionPath<ProductProjection>> expansionPaths()

Specified by:

expansionPaths in interface ExpansionPathContainer<ProductProjection>

Specified by:

expansionPaths in interface ReferenceExpansionSupport<ProductProjection>

plusExpansionPaths

ProductProjectionByIdGet plusExpansionPaths(ExpansionPath<ProductProjection> expansionPath)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.

An example in the product projection context:

final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT);

assertThat(fetch.expansionPaths()).isEmpty();

final ProductProjectionByIdGet fetch2 =
        fetch.plusExpansionPaths(ProductProjectionExpansionModel.of().categories());

assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged").isEmpty();
assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("categories[*]")));
assertThat(fetch2).isNotSameAs(fetch);
See the test code.

Specified by:

plusExpansionPaths in interface ReferenceExpansionDsl<ProductProjection,ProductProjectionByIdGet>

Parameters:

expansionPath - the new expansion path to add to the existing ones

Returns:

new object

withExpansionPaths

ProductProjectionByIdGet withExpansionPaths(ExpansionPath<ProductProjection> expansionPath)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.

An example in the product projection context:

final ProductProjectionByIdGet fetch = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
                .withExpansionPaths(ProductProjectionExpansionModel.of().categories());

assertThat(fetch.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));

final ProductProjectionByIdGet fetch2 =
        fetch.withExpansionPaths(ProductProjectionExpansionModel.of().productType());

assertThat(fetch.expansionPaths()).overridingErrorMessage("old object is unchanged")
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));
assertThat(fetch2.expansionPaths()).isEqualTo(asList(ExpansionPath.of("productType")));
assertThat(fetch2).isNotSameAs(fetch);
See the test code.

This method also can be used to use the same expansions as in another request:

final ProductProjectionQuery query = ProductProjectionQuery.ofCurrent().withExpansionPaths(m -> m.categories());
final ProductProjectionSearch search = ProductProjectionSearch.ofCurrent().withExpansionPaths(query);
assertThat(query.expansionPaths())
        .hasSize(1)
        .as("reuse expansion spec from other request")
        .isEqualTo(search.expansionPaths());
See the test code.

Specified by:

withExpansionPaths in interface ReferenceExpansionDsl<ProductProjection,ProductProjectionByIdGet>

Parameters:

expansionPath - the new expansion paths

Returns:

new object

withExpansionPaths

ProductProjectionByIdGet withExpansionPaths(List<ExpansionPath<ProductProjection>> expansionPaths)

Description copied from interface: ReferenceExpansionDsl

Creates a new object with the properties of the old object but replaces all expansion paths with expansionPaths.

Specified by:

withExpansionPaths in interface ReferenceExpansionDsl<ProductProjection,ProductProjectionByIdGet>

Parameters:

expansionPaths - the new expansion paths

Returns:

new object