Package com.commercetools.api.models.order

Interface OrderReference

All Superinterfaces:
Identifiable<Order>, IdentifiableObjHolder<Order>, Reference, ReferenceMixin
public interface OrderReference extends Reference, Identifiable<Order>, IdentifiableObjHolder<Order>

Reference to an Order.

Example to create an instance using the builder pattern 

     OrderReference orderReference = OrderReference.builder()
             .id("{id}")
             .build()

  • Field Details

  • Method Details

    • getObj

      @Valid @Valid Order getObj()

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

      Specified by:
      getObj in interface IdentifiableObjHolder<Order>
      Returns:
      obj

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced Order.

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

    • setObj

      void setObj(Order obj)

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

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique identifier of the referenced Order.

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

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderReferenceBuilder builder()
      builder factory method for OrderReference
      Returns:
      builder

    • builder

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

    • withOrderReference

      default <T> T withOrderReference(Function<OrderReference,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<OrderReference> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference