Package com.commercetools.history.models.common

Interface ReturnItem

public interface ReturnItem
ReturnItem
Example to create an instance using the builder pattern 

     ReturnItem returnItem = ReturnItem.builder()
             .id("{id}")
             .quantity(1)
             .type("{type}")
             .comment("{comment}")
             .shipmentState(ReturnShipmentState.ADVISED)
             .paymentState(ReturnPaymentState.NON_REFUNDABLE)
             .lastModifiedAt("{lastModifiedAt}")
             .createdAt("{createdAt}")
             .build()

  • Method Details

    • getId

      @NotNull @NotNull String getId()
      Returns:
      id

    • getQuantity

      @NotNull @NotNull Integer getQuantity()
      Returns:
      quantity

    • getType

      @NotNull @NotNull String getType()
      Returns:
      type

    • getComment

      @NotNull @NotNull String getComment()
      Returns:
      comment

    • getShipmentState

      @NotNull @NotNull ReturnShipmentState getShipmentState()
      Returns:
      shipmentState

    • getPaymentState

      @NotNull @NotNull ReturnPaymentState getPaymentState()
      Returns:
      paymentState

    • getLastModifiedAt

      @NotNull @NotNull String getLastModifiedAt()
      Returns:
      lastModifiedAt

    • getCreatedAt

      @NotNull @NotNull String getCreatedAt()
      Returns:
      createdAt

    • setId

      void setId(String id)
      set id
      Parameters:
      id - value to be set

    • setQuantity

      void setQuantity(Integer quantity)
      set quantity
      Parameters:
      quantity - value to be set

    • setType

      void setType(String type)
      set type
      Parameters:
      type - value to be set

    • setComment

      void setComment(String comment)
      set comment
      Parameters:
      comment - value to be set

    • setShipmentState

      void setShipmentState(ReturnShipmentState shipmentState)
      set shipmentState
      Parameters:
      shipmentState - value to be set

    • setPaymentState

      void setPaymentState(ReturnPaymentState paymentState)
      set paymentState
      Parameters:
      paymentState - value to be set

    • setLastModifiedAt

      void setLastModifiedAt(String lastModifiedAt)
      set lastModifiedAt
      Parameters:
      lastModifiedAt - value to be set

    • setCreatedAt

      void setCreatedAt(String createdAt)
      set createdAt
      Parameters:
      createdAt - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ReturnItemBuilder builder()
      builder factory method for ReturnItem
      Returns:
      builder

    • builder

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

    • withReturnItem

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