Package com.commercetools.api.models.order_edit

Interface OrderEditReference

All Superinterfaces:
Identifiable<OrderEdit>, IdentifiableObjHolder<OrderEdit>, Reference, ReferenceMixin
public interface OrderEditReference extends Reference, Identifiable<OrderEdit>, IdentifiableObjHolder<OrderEdit>

Reference to an OrderEdit.

Example to create an instance using the builder pattern 

     OrderEditReference orderEditReference = OrderEditReference.builder()
             .id("{id}")
             .build()

  • Field Details

  • Method Details

    • getObj

      @Valid @Valid OrderEdit getObj()

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

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

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced OrderEdit.

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

    • setObj

      void setObj(OrderEdit obj)

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

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique identifier of the referenced OrderEdit.

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

    • of

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

    • of

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

    • copyDeep

      OrderEditReference copyDeep()
      Specified by:
      copyDeep in interface Reference

    • deepCopy

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

    • builder

      static OrderEditReferenceBuilder builder()
      builder factory method for OrderEditReference
      Returns:
      builder

    • builder

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

    • withOrderEditReference

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