io.sphere.sdk.shippingmethods.queries

Interface ShippingMethodByKeyGet

All Superinterfaces:

ExpansionPathContainer<ShippingMethod>, Get<ShippingMethod>, GetDsl<ShippingMethod,ShippingMethod,ShippingMethodByKeyGet>, MetaModelGetDsl<ShippingMethod,ShippingMethod,ShippingMethodByKeyGet,ShippingMethodExpansionModel<ShippingMethod>>, MetaModelReferenceExpansionDsl<ShippingMethod,ShippingMethodByKeyGet,ShippingMethodExpansionModel<ShippingMethod>>, ReferenceExpansionDsl<ShippingMethod,ShippingMethodByKeyGet>, ReferenceExpansionSupport<ShippingMethod>, SphereRequest<ShippingMethod>

public interface ShippingMethodByKeyGet
extends MetaModelGetDsl<ShippingMethod,ShippingMethod,ShippingMethodByKeyGet,ShippingMethodExpansionModel<ShippingMethod>>

Fetches a shipping method by key.

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.

Method Summary

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.

Methods inherited from interface io.sphere.sdk.queries.Get

deserialize

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize, httpRequestIntent

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

plusExpansionPaths, withExpansionPaths

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

plusExpansionPaths, plusExpansionPaths, plusExpansionPaths, withExpansionPaths, withExpansionPaths

Method Detail

of

static ShippingMethodByKeyGet of(String key)

expansionPaths

List<ExpansionPath<ShippingMethod>> expansionPaths()

Specified by:

expansionPaths in interface ExpansionPathContainer<ShippingMethod>

Specified by:

expansionPaths in interface ReferenceExpansionSupport<ShippingMethod>

plusExpansionPaths

ShippingMethodByKeyGet plusExpansionPaths(ExpansionPath<ShippingMethod> expansionPath)

Description copied from interface: ReferenceExpansionDsl

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.

Specified by:

plusExpansionPaths in interface ReferenceExpansionDsl<ShippingMethod,ShippingMethodByKeyGet>

Parameters:

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

Returns:

new object

withExpansionPaths

ShippingMethodByKeyGet withExpansionPaths(ExpansionPath<ShippingMethod> expansionPath)

Description copied from interface: ReferenceExpansionDsl

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.

Specified by:

withExpansionPaths in interface ReferenceExpansionDsl<ShippingMethod,ShippingMethodByKeyGet>

Parameters:

expansionPath - the new expansion paths

Returns:

new object

withExpansionPaths

ShippingMethodByKeyGet withExpansionPaths(List<ExpansionPath<ShippingMethod>> expansionPaths)

Description copied from interface: ReferenceExpansionDsl

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

Specified by:

withExpansionPaths in interface ReferenceExpansionDsl<ShippingMethod,ShippingMethodByKeyGet>

Parameters:

expansionPaths - the new expansion paths

Returns:

new object