Package com.commercetools.api.models.message

Class OrderLineItemRemovedMessageBuilder

java.lang.Object
com.commercetools.api.models.message.OrderLineItemRemovedMessageBuilder
All Implemented Interfaces:
Builder<OrderLineItemRemovedMessage>
public class OrderLineItemRemovedMessageBuilder extends Object implements Builder<OrderLineItemRemovedMessage>
OrderLineItemRemovedMessageBuilder
Example to create an instance using the builder pattern 

     OrderLineItemRemovedMessage orderLineItemRemovedMessage = OrderLineItemRemovedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .lineItemId("{lineItemId}")
             .removedQuantity(0.3)
             .newQuantity(0.3)
             .plusNewState(newStateBuilder -> newStateBuilder)
             .newTotalPrice(newTotalPriceBuilder -> newTotalPriceBuilder)
             .build()

  • Constructor Details

    • OrderLineItemRemovedMessageBuilder

      public OrderLineItemRemovedMessageBuilder()

  • Method Details

    • id

      public OrderLineItemRemovedMessageBuilder id(String id)

      Unique identifier of the Message. Can be used to track which Messages have been processed.

      Parameters:
      id - value to be set
      Returns:
      Builder

    • version

      public OrderLineItemRemovedMessageBuilder version(Long version)

      Version of a resource. In case of Messages, this is always 1.

      Parameters:
      version - value to be set
      Returns:
      Builder

    • createdAt

      public OrderLineItemRemovedMessageBuilder createdAt(ZonedDateTime createdAt)

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public OrderLineItemRemovedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

      public OrderLineItemRemovedMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)

      IDs and references that last modified the Message.

      Parameters:
      builder - function to build the lastModifiedBy value
      Returns:
      Builder

    • withLastModifiedBy

      public OrderLineItemRemovedMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

      IDs and references that last modified the Message.

      Parameters:
      builder - function to build the lastModifiedBy value
      Returns:
      Builder

    • lastModifiedBy

      public OrderLineItemRemovedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

      public OrderLineItemRemovedMessageBuilder createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)

      IDs and references that created the Message.

      Parameters:
      builder - function to build the createdBy value
      Returns:
      Builder

    • withCreatedBy

      public OrderLineItemRemovedMessageBuilder withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)

      IDs and references that created the Message.

      Parameters:
      builder - function to build the createdBy value
      Returns:
      Builder

    • createdBy

      public OrderLineItemRemovedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

      public OrderLineItemRemovedMessageBuilder sequenceNumber(Long sequenceNumber)

      Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

      Parameters:
      sequenceNumber - value to be set
      Returns:
      Builder

    • resource

      public OrderLineItemRemovedMessageBuilder resource(Reference resource)

      Reference to the resource on which the change or action was performed.

      Parameters:
      resource - value to be set
      Returns:
      Builder

    • resource

      public OrderLineItemRemovedMessageBuilder resource(Function<ReferenceBuilder,Builder<? extends Reference>> builder)

      Reference to the resource on which the change or action was performed.

      Parameters:
      builder - function to build the resource value
      Returns:
      Builder

    • resourceVersion

      public OrderLineItemRemovedMessageBuilder resourceVersion(Long resourceVersion)

      Version of the resource on which the change or action was performed.

      Parameters:
      resourceVersion - value to be set
      Returns:
      Builder

    • resourceUserProvidedIdentifiers

      public OrderLineItemRemovedMessageBuilder resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      builder - function to build the resourceUserProvidedIdentifiers value
      Returns:
      Builder

    • withResourceUserProvidedIdentifiers

      public OrderLineItemRemovedMessageBuilder withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiers> builder)

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      builder - function to build the resourceUserProvidedIdentifiers value
      Returns:
      Builder

    • resourceUserProvidedIdentifiers

      public OrderLineItemRemovedMessageBuilder resourceUserProvidedIdentifiers(@Nullable UserProvidedIdentifiers resourceUserProvidedIdentifiers)

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      resourceUserProvidedIdentifiers - value to be set
      Returns:
      Builder

    • lineItemId

      public OrderLineItemRemovedMessageBuilder lineItemId(String lineItemId)

      Unique identifier of the Line Item.

      Parameters:
      lineItemId - value to be set
      Returns:
      Builder

    • lineItemKey

      public OrderLineItemRemovedMessageBuilder lineItemKey(@Nullable String lineItemKey)

      User-defined unique identifier of the LineItem.

      Parameters:
      lineItemKey - value to be set
      Returns:
      Builder

    • removedQuantity

      public OrderLineItemRemovedMessageBuilder removedQuantity(Long removedQuantity)

      Quantity of Line Items that were removed during the Remove LineItem update action.

      Parameters:
      removedQuantity - value to be set
      Returns:
      Builder

    • newQuantity

      public OrderLineItemRemovedMessageBuilder newQuantity(Long newQuantity)

      Line Item quantity after the Remove LineItem update action.

      Parameters:
      newQuantity - value to be set
      Returns:
      Builder

    • newState

      public OrderLineItemRemovedMessageBuilder newState(ItemState... newState)

      ItemStates after the Remove LineItem update action.

      Parameters:
      newState - value to be set
      Returns:
      Builder

    • newState

      public OrderLineItemRemovedMessageBuilder newState(List<ItemState> newState)

      ItemStates after the Remove LineItem update action.

      Parameters:
      newState - value to be set
      Returns:
      Builder

    • plusNewState

      public OrderLineItemRemovedMessageBuilder plusNewState(ItemState... newState)

      ItemStates after the Remove LineItem update action.

      Parameters:
      newState - value to be set
      Returns:
      Builder

    • plusNewState

      public OrderLineItemRemovedMessageBuilder plusNewState(Function<ItemStateBuilder,ItemStateBuilder> builder)

      ItemStates after the Remove LineItem update action.

      Parameters:
      builder - function to build the newState value
      Returns:
      Builder

    • withNewState

      public OrderLineItemRemovedMessageBuilder withNewState(Function<ItemStateBuilder,ItemStateBuilder> builder)

      ItemStates after the Remove LineItem update action.

      Parameters:
      builder - function to build the newState value
      Returns:
      Builder

    • addNewState

      public OrderLineItemRemovedMessageBuilder addNewState(Function<ItemStateBuilder,ItemState> builder)

      ItemStates after the Remove LineItem update action.

      Parameters:
      builder - function to build the newState value
      Returns:
      Builder

    • setNewState

      public OrderLineItemRemovedMessageBuilder setNewState(Function<ItemStateBuilder,ItemState> builder)

      ItemStates after the Remove LineItem update action.

      Parameters:
      builder - function to build the newState value
      Returns:
      Builder

    • newTotalPrice

      public OrderLineItemRemovedMessageBuilder newTotalPrice(Function<CentPrecisionMoneyBuilder,CentPrecisionMoneyBuilder> builder)

      totalPrice of the Order after the Remove LineItem update action.

      Parameters:
      builder - function to build the newTotalPrice value
      Returns:
      Builder

    • withNewTotalPrice

      public OrderLineItemRemovedMessageBuilder withNewTotalPrice(Function<CentPrecisionMoneyBuilder,CentPrecisionMoney> builder)

      totalPrice of the Order after the Remove LineItem update action.

      Parameters:
      builder - function to build the newTotalPrice value
      Returns:
      Builder

    • newTotalPrice

      public OrderLineItemRemovedMessageBuilder newTotalPrice(CentPrecisionMoney newTotalPrice)

      totalPrice of the Order after the Remove LineItem update action.

      Parameters:
      newTotalPrice - value to be set
      Returns:
      Builder

    • newTaxedPrice

      public OrderLineItemRemovedMessageBuilder newTaxedPrice(Function<TaxedItemPriceBuilder,TaxedItemPriceBuilder> builder)

      TaxedItemPrice of the Order after the Remove LineItem update action.

      Parameters:
      builder - function to build the newTaxedPrice value
      Returns:
      Builder

    • withNewTaxedPrice

      public OrderLineItemRemovedMessageBuilder withNewTaxedPrice(Function<TaxedItemPriceBuilder,TaxedItemPrice> builder)

      TaxedItemPrice of the Order after the Remove LineItem update action.

      Parameters:
      builder - function to build the newTaxedPrice value
      Returns:
      Builder

    • newTaxedPrice

      public OrderLineItemRemovedMessageBuilder newTaxedPrice(@Nullable TaxedItemPrice newTaxedPrice)

      TaxedItemPrice of the Order after the Remove LineItem update action.

      Parameters:
      newTaxedPrice - value to be set
      Returns:
      Builder

    • newPrice

      public OrderLineItemRemovedMessageBuilder newPrice(Function<PriceBuilder,PriceBuilder> builder)

      Price of the Order after the Remove LineItem update action.

      Parameters:
      builder - function to build the newPrice value
      Returns:
      Builder

    • withNewPrice

      public OrderLineItemRemovedMessageBuilder withNewPrice(Function<PriceBuilder,Price> builder)

      Price of the Order after the Remove LineItem update action.

      Parameters:
      builder - function to build the newPrice value
      Returns:
      Builder

    • newPrice

      public OrderLineItemRemovedMessageBuilder newPrice(@Nullable Price newPrice)

      Price of the Order after the Remove LineItem update action.

      Parameters:
      newPrice - value to be set
      Returns:
      Builder

    • newShippingDetail

      public OrderLineItemRemovedMessageBuilder newShippingDetail(Function<ItemShippingDetailsBuilder,ItemShippingDetailsBuilder> builder)

      Shipping Details of the Order after the Remove LineItem update action.

      Parameters:
      builder - function to build the newShippingDetail value
      Returns:
      Builder

    • withNewShippingDetail

      public OrderLineItemRemovedMessageBuilder withNewShippingDetail(Function<ItemShippingDetailsBuilder,ItemShippingDetails> builder)

      Shipping Details of the Order after the Remove LineItem update action.

      Parameters:
      builder - function to build the newShippingDetail value
      Returns:
      Builder

    • newShippingDetail

      public OrderLineItemRemovedMessageBuilder newShippingDetail(@Nullable ItemShippingDetails newShippingDetail)

      Shipping Details of the Order after the Remove LineItem update action.

      Parameters:
      newShippingDetail - value to be set
      Returns:
      Builder

    • getId

      public String getId()

      Unique identifier of the Message. Can be used to track which Messages have been processed.

      Returns:
      id

    • getVersion

      public Long getVersion()

      Version of a resource. In case of Messages, this is always 1.

      Returns:
      version

    • getCreatedAt

      public ZonedDateTime getCreatedAt()

      Date and time (UTC) the Message was generated.

      Returns:
      createdAt

    • getLastModifiedAt

      public ZonedDateTime getLastModifiedAt()

      Value of createdAt.

      Returns:
      lastModifiedAt

    • getLastModifiedBy

      @Nullable public LastModifiedBy getLastModifiedBy()

      IDs and references that last modified the Message.

      Returns:
      lastModifiedBy

    • getCreatedBy

      @Nullable public CreatedBy getCreatedBy()

      IDs and references that created the Message.

      Returns:
      createdBy

    • getSequenceNumber

      public Long getSequenceNumber()

      Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

      Returns:
      sequenceNumber

    • getResource

      public Reference getResource()

      Reference to the resource on which the change or action was performed.

      Returns:
      resource

    • getResourceVersion

      public Long getResourceVersion()

      Version of the resource on which the change or action was performed.

      Returns:
      resourceVersion

    • getResourceUserProvidedIdentifiers

      @Nullable public UserProvidedIdentifiers getResourceUserProvidedIdentifiers()

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Returns:
      resourceUserProvidedIdentifiers

    • getLineItemId

      public String getLineItemId()

      Unique identifier of the Line Item.

      Returns:
      lineItemId

    • getLineItemKey

      @Nullable public String getLineItemKey()

      User-defined unique identifier of the LineItem.

      Returns:
      lineItemKey

    • getRemovedQuantity

      public Long getRemovedQuantity()

      Quantity of Line Items that were removed during the Remove LineItem update action.

      Returns:
      removedQuantity

    • getNewQuantity

      public Long getNewQuantity()

      Line Item quantity after the Remove LineItem update action.

      Returns:
      newQuantity

    • getNewState

      public List<ItemState> getNewState()

      ItemStates after the Remove LineItem update action.

      Returns:
      newState

    • getNewTotalPrice

      public CentPrecisionMoney getNewTotalPrice()

      totalPrice of the Order after the Remove LineItem update action.

      Returns:
      newTotalPrice

    • getNewTaxedPrice

      @Nullable public TaxedItemPrice getNewTaxedPrice()

      TaxedItemPrice of the Order after the Remove LineItem update action.

      Returns:
      newTaxedPrice

    • getNewPrice

      @Nullable public Price getNewPrice()

      Price of the Order after the Remove LineItem update action.

      Returns:
      newPrice

    • getNewShippingDetail

      @Nullable public ItemShippingDetails getNewShippingDetail()

      Shipping Details of the Order after the Remove LineItem update action.

      Returns:
      newShippingDetail

    • build

      public OrderLineItemRemovedMessage build()
      builds OrderLineItemRemovedMessage with checking for non-null required values
      Specified by:
      build in interface Builder<OrderLineItemRemovedMessage>
      Returns:
      OrderLineItemRemovedMessage

    • buildUnchecked

      public OrderLineItemRemovedMessage buildUnchecked()
      builds OrderLineItemRemovedMessage without checking for non-null required values
      Returns:
      OrderLineItemRemovedMessage

    • of

      public static OrderLineItemRemovedMessageBuilder of()
      factory method for an instance of OrderLineItemRemovedMessageBuilder
      Returns:
      builder

    • of

      public static OrderLineItemRemovedMessageBuilder of(OrderLineItemRemovedMessage template)
      create builder for OrderLineItemRemovedMessage instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder