io.sphere.sdk.expansion

Interface MetaModelReferenceExpansionDsl<T,C,E>

All Superinterfaces:

ExpansionPathContainer<T>, ReferenceExpansionDsl<T,C>, 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, InventoryEntryByIdGet, InventoryEntryCreateCommand, InventoryEntryDeleteCommand, InventoryEntryQuery, InventoryEntryUpdateCommand, JsonNodeQuery, MessageByIdGet, MessageQuery, MetaModelExpansionDslExpansionModelRead<T,C,E>, MetaModelGetDsl<R,T,C,E>, MetaModelQueryDsl<T,C,Q,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, 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 MetaModelReferenceExpansionDsl<T,C,E>
extends ReferenceExpansionDsl<T,C>

Method Summary

Modifier and Type	Method and Description
C	plusExpansionPaths(Function<E,ExpansionPathContainer<T>> m) Creates a new object with the properties of the old object but adds a new expansion path to it by using meta models.
C	withExpansionPaths(Function<E,ExpansionPathContainer<T>> m) Creates a new object with the properties of the old object but replaces all expansion paths with a single expansionPath by using meta models.

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

plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths, withExpansionPaths

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

expansionPaths

Method Detail

plusExpansionPaths

C plusExpansionPaths(Function<E,ExpansionPathContainer<T>> m)

Creates a new object with the properties of the old object but adds a new expansion path to it by using meta models.

An example in the product projection context:

final ProductProjectionByIdGet fetch1 = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
        .plusExpansionPaths(m -> m.categories());
assertThat(fetch1.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]")));

final ProductProjectionByIdGet fetch2 = fetch1.plusExpansionPaths(m -> m.productType());
assertThat(fetch2.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]"), ExpansionPath.of("productType")))
        .isEqualTo(listOf(fetch1.expansionPaths(), ExpansionPath.of("productType")));

//this is equivalent to

final ExpansionPath<ProductProjection> categoryExpand = ProductProjectionExpansionModel.of().categories().expansionPaths().get(0);
final ExpansionPath<ProductProjection> productTypeExpand = ProductProjectionExpansionModel.of().productType().expansionPaths().get(0);
final ProductProjectionByIdGet fetchB = ProductProjectionByIdGet.of("id", ProductProjectionType.CURRENT)
                .withExpansionPaths(asList(categoryExpand, productTypeExpand));
assertThat(fetchB.expansionPaths())
        .isEqualTo(asList(ExpansionPath.of("categories[*]"), ExpansionPath.of("productType")));
See the test code.

Parameters:

m - function to use the meta model for expansions to create an expansion path

Returns:

new object

withExpansionPaths

C withExpansionPaths(Function<E,ExpansionPathContainer<T>> m)

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

An example in the product projection context:

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

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

final ProductProjectionByIdGet fetch2 =
        fetch.withExpansionPaths(m -> m.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.

Parameters:

m - function to use the meta model for expansions to create an expansion path

Returns:

new object