public interface CartByIdGet extends MetaModelGetDsl<Cart,Cart,CartByIdGet,CartExpansionModel<Cart>>
final Cart cart = createCartWithCountry(client());
final String id = cart.getId();
final Cart fetchedCart = client().executeBlocking(CartByIdGet.of(id));
assertThat(fetchedCart).isEqualTo(cart);
See the test code.
Modifier and Type | Method and Description |
---|---|
List<ExpansionPath<Cart>> |
expansionPaths() |
static CartByIdGet |
of(Identifiable<Cart> resource) |
static CartByIdGet |
of(String id) |
CartByIdGet |
plusExpansionPaths(ExpansionPath<Cart> expansionPath)
Creates a new object with the properties of the old object but adds
expansionPath to the expansion paths. |
CartByIdGet |
withExpansionPaths(ExpansionPath<Cart> expansionPath)
Creates a new object with the properties of the old object but replaces all expansion paths with a single
expansionPath . |
CartByIdGet |
withExpansionPaths(List<ExpansionPath<Cart>> expansionPaths)
Creates a new object with the properties of the old object but replaces all expansion paths with
expansionPaths . |
deserialize
canDeserialize, httpRequestIntent
plusExpansionPaths, withExpansionPaths
plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths
static CartByIdGet of(String id)
static CartByIdGet of(Identifiable<Cart> resource)
List<ExpansionPath<Cart>> expansionPaths()
expansionPaths
in interface ExpansionPathContainer<Cart>
expansionPaths
in interface ReferenceExpansionSupport<Cart>
CartByIdGet plusExpansionPaths(ExpansionPath<Cart> expansionPath)
ReferenceExpansionDsl
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.
plusExpansionPaths
in interface ReferenceExpansionDsl<Cart,CartByIdGet>
expansionPath
- the new expansion path to add to the existing onesCartByIdGet withExpansionPaths(ExpansionPath<Cart> expansionPath)
ReferenceExpansionDsl
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.
withExpansionPaths
in interface ReferenceExpansionDsl<Cart,CartByIdGet>
expansionPath
- the new expansion pathsCartByIdGet withExpansionPaths(List<ExpansionPath<Cart>> expansionPaths)
ReferenceExpansionDsl
expansionPaths
.withExpansionPaths
in interface ReferenceExpansionDsl<Cart,CartByIdGet>
expansionPaths
- the new expansion paths