Package com.broadleafcommerce.billing.domain

Class RefundEvent

java.lang.Object

com.broadleafcommerce.billing.domain.RefundEvent

All Implemented Interfaces:

com.broadleafcommerce.data.tracking.core.ContextStateAware

public class RefundEvent
extends Object
implements com.broadleafcommerce.data.tracking.core.ContextStateAware

This represents a specific instance of refunding a user for a BillingEvent. This domain contains the summary fields, while the details and items store detailed information.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<@Size(max=255) String,@Size(max=2000) String>	additionalFields

Constructor Summary

Constructors

Constructor	Description
RefundEvent()
RefundEvent(String id, Date refundDate, String billingEventId, RefundEventStatusEnum refundStatus, BigDecimal refundTotal, BigDecimal refundTaxAmount, String eventNotificationChannel, Date createdDate, Map<@Size(max=255) String,@Size(max=2000) String> additionalFields, com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<@Size(max=255) String,@Size(max=2000) String>	getAdditionalFields()
String	getBillingEventId()	The BillingEvent whose payment this refund event is refunding
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState	getContextState()	A subset of Tracking information to expose the context state for this object.
Date	getCreatedDate()
String	getEventNotificationChannel()	Notification channel for sending the processing events for this refund event
String	getId()
Date	getRefundDate()	When to process the refund
RefundEventStatusEnum	getRefundStatus()	Status of this refund
BigDecimal	getRefundTaxAmount()	The total tax of this refund event.
BigDecimal	getRefundTotal()	The total amount this refund event represents.
int	hashCode()
void	setAdditionalFields(Map<@Size(max=255) String,@Size(max=2000) String> additionalFields)
void	setBillingEventId(String billingEventId)	The BillingEvent whose payment this refund event is refunding
void	setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)	A subset of Tracking information to expose the context state for this object.
void	setCreatedDate(Date createdDate)
void	setEventNotificationChannel(String eventNotificationChannel)	Notification channel for sending the processing events for this refund event
void	setId(String id)
void	setRefundDate(Date refundDate)	When to process the refund
void	setRefundStatus(RefundEventStatusEnum refundStatus)	Status of this refund
void	setRefundTaxAmount(BigDecimal refundTaxAmount)	The total tax of this refund event.
void	setRefundTotal(BigDecimal refundTotal)	The total amount this refund event represents.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

additionalFields

protected Map<@Size(max=255) String,@Size(max=2000) String> additionalFields

Constructor Details

RefundEvent

public RefundEvent()

RefundEvent

public RefundEvent(String id,
 Date refundDate,
 String billingEventId,
 RefundEventStatusEnum refundStatus,
 BigDecimal refundTotal,
 BigDecimal refundTaxAmount,
 String eventNotificationChannel,
 Date createdDate,
 Map<@Size(max=255) String,@Size(max=2000) String> additionalFields,
 com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)

Method Details

getId

public String getId()

getRefundDate

public Date getRefundDate()

When to process the refund

getBillingEventId

public String getBillingEventId()

The BillingEvent whose payment this refund event is refunding

getRefundStatus

public RefundEventStatusEnum getRefundStatus()

Status of this refund

See Also:

• RefundEventStatusEnum

getRefundTotal

public BigDecimal getRefundTotal()

The total amount this refund event represents. This should be the sum of the refund amounts from the RefundEventDetail.

getRefundTaxAmount

public BigDecimal getRefundTaxAmount()

The total tax of this refund event. Mainly used for reporting purposes.

getEventNotificationChannel

public String getEventNotificationChannel()

Notification channel for sending the processing events for this refund event

getCreatedDate

public Date getCreatedDate()

getAdditionalFields

public Map<@Size(max=255) String,@Size(max=2000) String> getAdditionalFields()

getContextState

public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()

A subset of Tracking information to expose the context state for this object.

Specified by:

getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

setId

public void setId(String id)

setRefundDate

public void setRefundDate(Date refundDate)

When to process the refund

setBillingEventId

public void setBillingEventId(String billingEventId)

The BillingEvent whose payment this refund event is refunding

setRefundStatus

public void setRefundStatus(RefundEventStatusEnum refundStatus)

Status of this refund

See Also:

• RefundEventStatusEnum

setRefundTotal

public void setRefundTotal(BigDecimal refundTotal)

The total amount this refund event represents. This should be the sum of the refund amounts from the RefundEventDetail.

setRefundTaxAmount

public void setRefundTaxAmount(BigDecimal refundTaxAmount)

The total tax of this refund event. Mainly used for reporting purposes.

setEventNotificationChannel

public void setEventNotificationChannel(String eventNotificationChannel)

Notification channel for sending the processing events for this refund event

setCreatedDate

public void setCreatedDate(Date createdDate)

setAdditionalFields

public void setAdditionalFields(Map<@Size(max=255) String,@Size(max=2000) String> additionalFields)

setContextState

public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)

A subset of Tracking information to expose the context state for this object.

Specified by:

setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

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