io.sphere.sdk.shippingmethods.ShippingMethod Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commercetools-models Show documentation
There is a newer version: 2.16.0
package io.sphere.sdk.shippingmethods;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.sphere.sdk.annotations.*;
import io.sphere.sdk.carts.CartShippingInfo;
import io.sphere.sdk.models.*;
import io.sphere.sdk.taxcategories.TaxCategory;
import io.sphere.sdk.types.Custom;
import io.sphere.sdk.types.CustomFields;
import io.sphere.sdk.zones.Zone;

import javax.annotation.Nullable;
import java.util.Collections;
import java.util.List;

import static java.util.stream.Collectors.toList;


/**
 * Shipping Methods define where orders can be shipped and what the costs are.
 *
 * @see io.sphere.sdk.shippingmethods.commands.ShippingMethodCreateCommand
 * @see io.sphere.sdk.shippingmethods.commands.ShippingMethodUpdateCommand
 * @see io.sphere.sdk.shippingmethods.commands.ShippingMethodDeleteCommand
 * @see io.sphere.sdk.shippingmethods.queries.ShippingMethodQuery
 * @see io.sphere.sdk.shippingmethods.queries.ShippingMethodByIdGet
 * @see CartShippingInfo#getShippingMethod()
 * @see io.sphere.sdk.orders.OrderShippingInfo#getShippingMethod()
 */
@JsonDeserialize(as = ShippingMethodImpl.class)
@ResourceValue
@HasQueryEndpoint(additionalContentsQueryInterface = "\n" +
        "    default ShippingMethodQuery byName(final String name) {\n" +
        "        return withPredicates(ShippingMethodQueryModel.of().name().is(name));\n" +
        "    }\n" +
        "\n" +
        "    default ShippingMethodQuery byTaxCategory(final io.sphere.sdk.models.Referenceable taxCategory) {\n" +
        "        return withPredicates(m -> m.taxCategory().is(taxCategory));\n" +
        "    }\n" +
        "\n" +
        "    default ShippingMethodQuery byIsDefault() {\n" +
        "        return withPredicates(m -> m.isDefault().is(true));\n" +
        "    }\n" +
        "\n" +
        "    default ShippingMethodQuery byKey(final String key) {\n" +
        "        return withPredicates(ShippingMethodQueryModel.of().key().is(key));\n" +
        "    }")
@ResourceInfo(pluralName = "shipping methods", pathElement = "shipping-methods")
@HasByIdGetEndpoint(javadocSummary = "Fetches a shipping method by ID.", includeExamples = "io.sphere.sdk.shippingmethods.queries.ShippingMethodByIdGetIntegrationTest#execution()")
@HasByKeyGetEndpoint(javadocSummary = "Fetches a shipping method by key.", includeExamples = "io.sphere.sdk.shippingmethods.queries.ShippingMethodByKeyGetIntegrationTest#execution()")
@HasCreateCommand(javadocSummary = "Creates a {@link io.sphere.sdk.shippingmethods.ShippingMethod}.", includeExamples = "io.sphere.sdk.shippingmethods.commands.ShippingMethodCreateCommandIntegrationTest#execution()")
@HasUpdateCommand(updateWith = "key")
@HasQueryModel(additionalContents = "BooleanQueryModel isDefault();")
@HasUpdateActions
@HasDeleteCommand(deleteWith = "key")
public interface ShippingMethod extends Resource, WithKey, Custom {

    @Nullable
    String getKey();

    String getName();

    @Deprecated
    @Nullable
    @IgnoreInQueryModel
    String getDescription();

    @Nullable
    @IgnoreInQueryModel
    @HasUpdateAction
    LocalizedString getLocalizedDescription();

    @Nullable
    @IgnoreInQueryModel
    @HasUpdateAction
    LocalizedString getLocalizedName();

    Reference getTaxCategory();

    @QueryModelHint(type = "ZoneRateCollectionQueryModel", impl = "return new ZoneRateCollectionQueryModelImpl<>(this, fieldName);")
    List getZoneRates();

    default List getShippingRatesForZone(final Referenceable zone) {
        return getZoneRates().stream()
                .filter(rate -> rate.getZone().hasSameIdAs(zone.toReference()))
                .findFirst()
                .map(rate -> rate.getShippingRates())
                .orElse(Collections.emptyList());
    }

    default List> getZones() {
        return getZoneRates().stream().map(rate -> rate.getZone()).collect(toList());
    }

    @JsonProperty("isDefault")
    @IgnoreInQueryModel
    @HasNoUpdateAction
    Boolean isDefault();

    @IgnoreInQueryModel
    @Nullable
    String getPredicate();

    @Nullable
    CustomFields getCustom();

    @Override
    default Reference toReference() {
        return Reference.of(referenceTypeId(), getId(), this);
    }

    /**
     * A type hint for references which resource type is linked in a reference.
     *
     * @return type hint
     * @see Reference#getTypeId()
     */
    static String referenceTypeId() {
        return "shipping-method";
    }

    /**
     * Creates a container which contains the full Java type information to deserialize this class from JSON.
     *
     * @return type reference
     * @see io.sphere.sdk.json.SphereJsonUtils#readObject(byte[], TypeReference)
     * @see io.sphere.sdk.json.SphereJsonUtils#readObject(String, TypeReference)
     * @see io.sphere.sdk.json.SphereJsonUtils#readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference)
     * @see io.sphere.sdk.json.SphereJsonUtils#readObjectFromResource(String, TypeReference)
     */
    static TypeReference typeReference() {
        return new TypeReference() {
            @Override
            public String toString() {
                return "TypeReference";
            }
        };
    }

    /**
     * Creates a reference for one item of this class by a known ID.
     * 
     * 
An example for categories but this applies for other resources, too:
     * {@include.example io.sphere.sdk.categories.CategoryTest#referenceOfId()}
     * 
     * 
If you already have a resource object, then use {@link #toReference()} instead:
     * 
     * {@include.example io.sphere.sdk.categories.CategoryTest#toReference()}
     *
     * @param id the ID of the resource which should be referenced.
     * @return reference
     */
    static Reference referenceOfId(final String id) {
        return Reference.of(referenceTypeId(), id);
    }
}