Package com.commercetools.api.models.recurring_order

Interface RecurringOrderReference

All Superinterfaces:
Reference, ReferenceMixin
public interface RecurringOrderReference extends Reference

Reference to a RecurringOrder.

Example to create an instance using the builder pattern 

     RecurringOrderReference recurringOrderReference = RecurringOrderReference.builder()
             .id("{id}")
             .build()

  • Field Details

    • RECURRING_ORDER

      static final String RECURRING_ORDER
      discriminator value for RecurringOrderReference
      See Also:

  • Method Details

    • getObj

      @Valid @Valid RecurringOrder getObj()

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

      Returns:
      obj

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced RecurringOrder.

      Specified by:
      getId in interface Reference
      Specified by:
      getId in interface ReferenceMixin
      Returns:
      id

    • setObj

      void setObj(RecurringOrder obj)

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

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique identifier of the referenced RecurringOrder.

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

    • of

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

    • of

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

    • copyDeep

      RecurringOrderReference copyDeep()
      Specified by:
      copyDeep in interface Reference

    • deepCopy

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

    • builder

      static RecurringOrderReferenceBuilder builder()
      builder factory method for RecurringOrderReference
      Returns:
      builder

    • builder

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

    • withRecurringOrderReference

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