public interface ShippingMethodByKeyGet extends MetaModelGetDsl<ShippingMethod,ShippingMethod,ShippingMethodByKeyGet,ShippingMethodExpansionModel<ShippingMethod>>
final String key = randomKey();
withUpdateableShippingMethod(client(), builder -> builder.key(key), shippingMethod -> {
final ShippingMethodByKeyGet getByKey = ShippingMethodByKeyGet.of(key);
final ShippingMethod shippingMethodByKey = client().executeBlocking(getByKey);
assertThat(shippingMethodByKey).isNotNull();
assertThat(shippingMethodByKey.getKey()).isEqualTo(key);
return shippingMethod;
});
See the test code.
| Modifier and Type | Method and Description |
|---|---|
List<ExpansionPath<ShippingMethod>> |
expansionPaths() |
static ShippingMethodByKeyGet |
of(String key) |
ShippingMethodByKeyGet |
plusExpansionPaths(ExpansionPath<ShippingMethod> expansionPath)
Creates a new object with the properties of the old object but adds
expansionPath to the expansion paths. |
ShippingMethodByKeyGet |
withExpansionPaths(ExpansionPath<ShippingMethod> expansionPath)
Creates a new object with the properties of the old object but replaces all expansion paths with a single
expansionPath. |
ShippingMethodByKeyGet |
withExpansionPaths(List<ExpansionPath<ShippingMethod>> expansionPaths)
Creates a new object with the properties of the old object but replaces all expansion paths with
expansionPaths. |
deserializecanDeserialize, httpRequestIntentplusExpansionPaths, withExpansionPathsplusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPathsstatic ShippingMethodByKeyGet of(String key)
List<ExpansionPath<ShippingMethod>> expansionPaths()
expansionPaths in interface ExpansionPathContainer<ShippingMethod>expansionPaths in interface ReferenceExpansionSupport<ShippingMethod>ShippingMethodByKeyGet plusExpansionPaths(ExpansionPath<ShippingMethod> expansionPath)
ReferenceExpansionDslexpansionPath 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.
plusExpansionPaths in interface ReferenceExpansionDsl<ShippingMethod,ShippingMethodByKeyGet>expansionPath - the new expansion path to add to the existing onesShippingMethodByKeyGet withExpansionPaths(ExpansionPath<ShippingMethod> expansionPath)
ReferenceExpansionDslexpansionPath.
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.
withExpansionPaths in interface ReferenceExpansionDsl<ShippingMethod,ShippingMethodByKeyGet>expansionPath - the new expansion pathsShippingMethodByKeyGet withExpansionPaths(List<ExpansionPath<ShippingMethod>> expansionPaths)
ReferenceExpansionDslexpansionPaths.withExpansionPaths in interface ReferenceExpansionDsl<ShippingMethod,ShippingMethodByKeyGet>expansionPaths - the new expansion paths