Package com.broadleafcommerce.orderoperation.service.messaging.voucher

Class VoucherGenerationCompletionEvent

java.lang.Object
com.broadleafcommerce.orderoperation.service.messaging.voucher.VoucherGenerationCompletionEvent
All Implemented Interfaces:
Serializable
public class VoucherGenerationCompletionEvent extends Object implements Serializable
A message event dispatched after a voucher validation and code generation completes successfully. This event should be consumed by services that need to perform any post-voucher-code-generation activities.
Author:
Sunny Yu
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ORDER_LINK_KEY
    The key for the link to read the Order by id.

  • Constructor Summary

    Constructors
    Constructor
    Description
    VoucherGenerationCompletionEvent()
     
    VoucherGenerationCompletionEvent(com.broadleafcommerce.order.client.domain.Order order, Map<String,OrderLink> links, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    com.broadleafcommerce.data.tracking.core.context.ContextInfo
    getContextInfo()
    The ContextInfo derived from the original request containing tenant and sandbox info.
    Map<String,OrderLink>
    getLinks()
    The links that can be used to read an additional data for the event if needed.
    com.broadleafcommerce.order.client.domain.Order
    getOrder()
    Deprecated.
    to reduce the message size this order shouldn't be used and instead, should be fetched the link in links map.
    int
    hashCode()
     
    void
    setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    The ContextInfo derived from the original request containing tenant and sandbox info.
    void
    setLinks(Map<String,OrderLink> links)
    The links that can be used to read an additional data for the event if needed.
    void
    setOrder(com.broadleafcommerce.order.client.domain.Order order)
    Deprecated.
    to reduce the message size this order shouldn't be used and instead, should be fetched the link in links map.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • VoucherGenerationCompletionEvent

      public VoucherGenerationCompletionEvent()

    • VoucherGenerationCompletionEvent

      public VoucherGenerationCompletionEvent(com.broadleafcommerce.order.client.domain.Order order, Map<String,OrderLink> links, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

  • Method Details

    • getOrder

      @Deprecated public com.broadleafcommerce.order.client.domain.Order getOrder()
      Deprecated.
      to reduce the message size this order shouldn't be used and instead, should be fetched the link in links map.
      The Order that the vouchers were created for.
      See Also:

    • getLinks

      public Map<String,OrderLink> getLinks()
      The links that can be used to read an additional data for the event if needed. These links are meant used instead of getOrder() to reduce the message payload size, esp. for large orders.

    • getContextInfo

      @Nullable public com.broadleafcommerce.data.tracking.core.context.ContextInfo getContextInfo()
      The ContextInfo derived from the original request containing tenant and sandbox info.
      Returns:
      The ContextInfo derived from the original request

    • setOrder

      @Deprecated public void setOrder(com.broadleafcommerce.order.client.domain.Order order)
      Deprecated.
      to reduce the message size this order shouldn't be used and instead, should be fetched the link in links map.
      The Order that the vouchers were created for.
      See Also:

    • setLinks

      public void setLinks(Map<String,OrderLink> links)
      The links that can be used to read an additional data for the event if needed. These links are meant used instead of getOrder() to reduce the message payload size, esp. for large orders.

    • setContextInfo

      public void setContextInfo(@Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      The ContextInfo derived from the original request containing tenant and sandbox info.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object