io.sphere.sdk.expansion

Interface ReferenceExpansionDsl<T,C>

All Superinterfaces:

ExpansionPathContainer<T>, ReferenceExpansionSupport<T>

All Known Subinterfaces:

ApiClientByIdGet, ApiClientCreateCommand, ApiClientQuery, CartByCustomerIdGet, CartByIdGet, CartByKeyGet, CartCreateCommand, CartDeleteCommand, CartDiscountByIdGet, CartDiscountByKeyGet, CartDiscountCreateCommand, CartDiscountDeleteCommand, CartDiscountQuery, CartDiscountUpdateCommand, CartInStoreByCustomerIdGet, CartInStoreByIdGet, CartInStoreByKeyGet, CartInStoreCreateCommand, CartInStoreDeleteCommand, CartInStoreQuery, CartInStoreUpdateCommand, CartQuery, CartUpdateCommand, CategoryByIdGet, CategoryByKeyGet, CategoryCreateCommand, CategoryDeleteCommand, CategoryQuery, CategoryUpdateCommand, ChannelByIdGet, ChannelCreateCommand, ChannelDeleteCommand, ChannelQuery, ChannelUpdateCommand, CustomerByEmailTokenGet, CustomerByIdGet, CustomerByKeyGet, CustomerByPasswordTokenGet, CustomerCreateCommand, CustomerDeleteCommand, CustomerGroupByIdGet, CustomerGroupByKeyGet, CustomerGroupCreateCommand, CustomerGroupDeleteCommand, CustomerGroupQuery, CustomerGroupUpdateCommand, CustomerInStoreByEmailTokenGet, CustomerInStoreByIdGet, CustomerInStoreByKeyGet, CustomerInStoreByPasswordTokenGet, CustomerInStoreCreateCommand, CustomerInStoreDeleteCommand, CustomerInStoreQuery, CustomerInStoreUpdateCommand, CustomerQuery, CustomerUpdateCommand, CustomObjectByIdGet<T>, CustomObjectByKeyGet<T>, CustomObjectQuery<T>, DiscountCodeByIdGet, DiscountCodeCreateCommand, DiscountCodeDeleteCommand, DiscountCodeQuery, DiscountCodeUpdateCommand, ExtensionByIdGet, ExtensionByKeyGet, ExtensionCreateCommand, ExtensionDeleteCommand, ExtensionQuery, ExtensionUpdateCommand, GetDsl<R,T,C>, InventoryEntryByIdGet, InventoryEntryCreateCommand, InventoryEntryDeleteCommand, InventoryEntryQuery, InventoryEntryUpdateCommand, JsonNodeQuery, MessageByIdGet, MessageQuery, MetaModelExpansionDslExpansionModelRead<T,C,E>, MetaModelGetDsl<R,T,C,E>, MetaModelQueryDsl<T,C,Q,E>, MetaModelReferenceExpansionDsl<T,C,E>, MetaModelSearchDsl<T,C,S,L,F,E>, OrderByIdGet, OrderByOrderNumberGet, OrderDeleteCommand, OrderEditByIdGet, OrderEditByKeyGet, OrderEditCreateCommand, OrderEditDeleteCommand, OrderEditQuery, OrderEditUpdateCommand, OrderFromCartCreateCommand, OrderFromCartInStoreCreateCommand, OrderInStoreByIdGet, OrderInStoreByOrderNumberGet, OrderInStoreDeleteByIdCommand, OrderInStoreDeleteByOrderNumberCommand, OrderInStoreQuery, OrderInStoreUpdateByIdCommand, OrderInStoreUpdateByOrderNumberCommand, OrderQuery, OrderUpdateCommand, PaymentByIdGet, PaymentByKeyGet, PaymentCreateCommand, PaymentDeleteCommand, PaymentQuery, PaymentUpdateCommand, ProductByIdGet, ProductByIdProductSelectionGet, ProductByKeyGet, ProductByKeyProductSelectionGet, ProductCreateCommand, ProductDeleteCommand, ProductDiscountByIdGet, ProductDiscountByKeyGet, ProductDiscountCreateCommand, ProductDiscountDeleteCommand, ProductDiscountQuery, ProductDiscountUpdateCommand, ProductProjectionByIdGet, ProductProjectionByKeyGet, ProductProjectionInStoreByIdGet, ProductProjectionInStoreByKeyGet, ProductProjectionInStoreQuery, ProductProjectionQuery, ProductProjectionSearch, ProductQuery, ProductSelectionByIdGet, ProductSelectionByIdProductGet, ProductSelectionByIdProductsGet, ProductSelectionByKeyGet, ProductSelectionByKeyProductGet, ProductSelectionByKeyProductsGet, ProductSelectionCreateCommand, ProductSelectionDeleteCommand, ProductSelectionQuery, ProductSelectionUpdateCommand, ProductTypeByIdGet, ProductTypeByKeyGet, ProductTypeCreateCommand, ProductTypeDeleteCommand, ProductTypeQuery, ProductTypeUpdateCommand, ProductUpdateCommand, QueryDsl<T,C>, ReviewByIdGet, ReviewByKeyGet, ReviewCreateCommand, ReviewDeleteCommand, ReviewQuery, ReviewUpdateCommand, ShippingMethodByIdGet, ShippingMethodByKeyGet, ShippingMethodCreateCommand, ShippingMethodDeleteCommand, ShippingMethodQuery, ShippingMethodsByCartGet, ShippingMethodsByLocationGet, ShippingMethodsByOrderEditGet, ShippingMethodUpdateCommand, ShoppingListByIdGet, ShoppingListByKeyGet, ShoppingListCreateCommand, ShoppingListDeleteCommand, ShoppingListInStoreByIdGet, ShoppingListInStoreByKeyGet, ShoppingListInStoreCreateCommand, ShoppingListInStoreDeleteCommand, ShoppingListInStoreQuery, ShoppingListInStoreUpdateCommand, ShoppingListQuery, ShoppingListUpdateCommand, StateByIdGet, StateByKeyGet, StateCreateCommand, StateDeleteCommand, StateQuery, StateUpdateCommand, StoreByIdGet, StoreByKeyGet, StoreCreateCommand, StoreDeleteCommand, StoreQuery, StoreUpdateCommand, SubscriptionByIdGet, SubscriptionByKeyGet, SubscriptionCreateCommand, SubscriptionDeleteCommand, SubscriptionQuery, SubscriptionUpdateCommand, TaxCategoryByIdGet, TaxCategoryByKeyGet, TaxCategoryCreateCommand, TaxCategoryDeleteCommand, TaxCategoryQuery, TaxCategoryUpdateCommand, TypeByIdGet, TypeCreateCommand, TypeDeleteCommand, TypeQuery, TypeUpdateCommand, ZoneByIdGet, ZoneByKeyGet, ZoneCreateCommand, ZoneDeleteCommand, ZoneQuery, ZoneUpdateCommand

All Known Implementing Classes:

MetaModelByIdDeleteCommandImpl, MetaModelCreateCommandImpl, MetaModelGetDslImpl, MetaModelQueryDslImpl, MetaModelSearchDslImpl, MetaModelUpdateCommandDslImpl

public interface ReferenceExpansionDsl<T,C>
extends ReferenceExpansionSupport<T>

Method Summary

Modifier and Type	Method and Description
C	plusExpansionPaths(ExpansionPath<T> expansionPath) Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.
default C	plusExpansionPaths(ExpansionPathContainer<T> holder)
C	plusExpansionPaths(List<ExpansionPath<T>> expansionPaths) Creates a new object with the properties of the old object but adds expansionPaths to the expansion paths.
C	plusExpansionPaths(String expansionPath) Creates a new object with the properties of the old object but adds expansionPath to the expansion paths.
C	withExpansionPaths(ExpansionPath<T> expansionPath) Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.
default C	withExpansionPaths(ExpansionPathContainer<T> holder)
C	withExpansionPaths(List<ExpansionPath<T>> expansionPaths) Creates a new object with the properties of the old object but replaces all expansion paths with expansionPaths.
C	withExpansionPaths(String expansionPath) Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath.

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

expansionPaths

Method Detail

withExpansionPaths

C withExpansionPaths(List<ExpansionPath<T>> expansionPaths)

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

Parameters:

expansionPaths - the new expansion paths

Returns:

new object

withExpansionPaths

C withExpansionPaths(ExpansionPath<T> expansionPath)

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.

Parameters:

expansionPath - the new expansion paths

Returns:

new object

withExpansionPaths

C withExpansionPaths(String expansionPath)

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.

Parameters:

expansionPath - the new expansion paths

Returns:

new object

plusExpansionPaths

C plusExpansionPaths(List<ExpansionPath<T>> expansionPaths)

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

Parameters:

expansionPaths - the new expansion paths to add to the existing ones

Returns:

new object

plusExpansionPaths

C plusExpansionPaths(ExpansionPath<T> expansionPath)

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.

Parameters:

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

Returns:

new object

plusExpansionPaths

C plusExpansionPaths(String expansionPath)

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.

Parameters:

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

Returns:

new object

withExpansionPaths

default C withExpansionPaths(ExpansionPathContainer<T> holder)

plusExpansionPaths

default C plusExpansionPaths(ExpansionPathContainer<T> holder)