public interface CustomerGroupByKeyGet extends MetaModelGetDsl<CustomerGroup,CustomerGroup,CustomerGroupByKeyGet,CustomerGroupExpansionModel<CustomerGroup>>
withCustomerGroup(client(), customerGroup -> {
final String customerGroupKey = customerGroup.getKey();
assertThat(customerGroupKey).isNotEmpty();
final CustomerGroup fetchedCustomerGroup = client().executeBlocking(CustomerGroupByKeyGet.of(customerGroupKey));
assertThat(fetchedCustomerGroup).isEqualTo(customerGroup);
});
See the test code.
Modifier and Type | Method and Description |
---|---|
List<ExpansionPath<CustomerGroup>> |
expansionPaths() |
static CustomerGroupByKeyGet |
of(String key) |
CustomerGroupByKeyGet |
plusExpansionPaths(ExpansionPath<CustomerGroup> expansionPath)
Creates a new object with the properties of the old object but adds
expansionPath to the expansion paths. |
CustomerGroupByKeyGet |
withExpansionPaths(ExpansionPath<CustomerGroup> expansionPath)
Creates a new object with the properties of the old object but replaces all expansion paths with a single
expansionPath . |
CustomerGroupByKeyGet |
withExpansionPaths(List<ExpansionPath<CustomerGroup>> 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 CustomerGroupByKeyGet of(String key)
List<ExpansionPath<CustomerGroup>> expansionPaths()
expansionPaths
in interface ExpansionPathContainer<CustomerGroup>
expansionPaths
in interface ReferenceExpansionSupport<CustomerGroup>
CustomerGroupByKeyGet plusExpansionPaths(ExpansionPath<CustomerGroup> 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<CustomerGroup,CustomerGroupByKeyGet>
expansionPath
- the new expansion path to add to the existing onesCustomerGroupByKeyGet withExpansionPaths(ExpansionPath<CustomerGroup> 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<CustomerGroup,CustomerGroupByKeyGet>
expansionPath
- the new expansion pathsCustomerGroupByKeyGet withExpansionPaths(List<ExpansionPath<CustomerGroup>> expansionPaths)
ReferenceExpansionDsl
expansionPaths
.withExpansionPaths
in interface ReferenceExpansionDsl<CustomerGroup,CustomerGroupByKeyGet>
expansionPaths
- the new expansion paths