Package com.commercetools.api.models.shipping_method

Interface ShippingMethodReference

All Superinterfaces:
Identifiable<ShippingMethod>, Reference, ReferenceMixin
All Known Implementing Classes:
ShippingMethodReferenceImpl
public interface ShippingMethodReference extends Reference, Identifiable<ShippingMethod>

Reference to a ShippingMethod.

Example to create an instance using the builder pattern 

     ShippingMethodReference shippingMethodReference = ShippingMethodReference.builder()
             .id("{id}")
             .build()

  • Field Details

    • SHIPPING_METHOD

      static final String SHIPPING_METHOD
      discriminator value for ShippingMethodReference
      See Also:

  • Method Details

    • getObj

      @Valid @Valid ShippingMethod getObj()

      Contains the representation of the expanded ShippingMethod. Only present in responses to requests with Reference Expansion for ShippingMethods.

      Returns:
      obj

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced ShippingMethod.

      Specified by:
      getId in interface Identifiable<ShippingMethod>
      Specified by:
      getId in interface Reference
      Specified by:
      getId in interface ReferenceMixin
      Returns:
      id

    • setObj

      void setObj(ShippingMethod obj)

      Contains the representation of the expanded ShippingMethod. Only present in responses to requests with Reference Expansion for ShippingMethods.

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique identifier of the referenced ShippingMethod.

      Specified by:
      setId in interface Reference
      Parameters:
      id - value to be set

    • of

      static ShippingMethodReference of()
      factory method
      Returns:
      instance of ShippingMethodReference

    • of

      static ShippingMethodReference of(ShippingMethodReference template)
      factory method to create a shallow copy ShippingMethodReference
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static ShippingMethodReference deepCopy(@Nullable ShippingMethodReference template)
      factory method to create a deep copy of ShippingMethodReference
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ShippingMethodReferenceBuilder builder()
      builder factory method for ShippingMethodReference
      Returns:
      builder

    • builder

      static ShippingMethodReferenceBuilder builder(ShippingMethodReference template)
      create builder for ShippingMethodReference instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withShippingMethodReference

      default <T> T withShippingMethodReference(Function<ShippingMethodReference,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ShippingMethodReference> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference