Package com.broadleafcommerce.billing.domain

Class BillingEventPayment

java.lang.Object
com.broadleafcommerce.billing.domain.BillingEventPayment
All Implemented Interfaces:
RetryPayment, com.broadleafcommerce.data.tracking.core.ContextStateAware
public class BillingEventPayment extends Object implements RetryPayment, com.broadleafcommerce.data.tracking.core.ContextStateAware
A payment associated with a BillingEvent.

  • Constructor Details

    • BillingEventPayment

      public BillingEventPayment()

    • BillingEventPayment

      public BillingEventPayment(String id, String billingEventId, String paymentProcessType, PaymentStatusEnum paymentStatus, BigDecimal paymentAmount, String preferredPaymentAccountId, String retryScheduleCode, Date nextRetryDate, Integer remainingRetryCount, Integer attemptCount, Date createdDate, Integer version, com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)

  • Method Details

    • getId

      public String getId()

    • getBillingEventId

      public String getBillingEventId()
      The BillingEvent associated with this payment

    • getPaymentProcessType

      public String getPaymentProcessType()
      Serves as a reference to the process that's meant to collect payment for this BillingEventPayment

    • getPaymentStatus

      public PaymentStatusEnum getPaymentStatus()
      The payment status of the BillingEventPayment.
      See Also:

    • getPaymentAmount

      public BigDecimal getPaymentAmount()
      The amount to be billed on this payment.

    • getPreferredPaymentAccountId

      public String getPreferredPaymentAccountId()
      The ID of the preferred payment account to use for this payment.

    • getRetryScheduleCode

      public String getRetryScheduleCode()
      The IntervalBillingRetrySpecs to use when calculating the retry date.
      Specified by:
      getRetryScheduleCode in interface RetryPayment
      See Also:

    • getNextRetryDate

      public Date getNextRetryDate()
      In the case of a failed payment, the next date to try processing payment.
      Specified by:
      getNextRetryDate in interface RetryPayment
      See Also:

    • getRemainingRetryCount

      public Integer getRemainingRetryCount()
      The remaining number of tries to retry this payment.
      Specified by:
      getRemainingRetryCount in interface RetryPayment
      See Also:

    • getAttemptCount

      public Integer getAttemptCount()
      The current attempt number.
      Specified by:
      getAttemptCount in interface RetryPayment
      See Also:

    • getCreatedDate

      public Date getCreatedDate()
      Creation date of this payment. This should not be manually set or updated.

    • getVersion

      public Integer getVersion()
      The version of this payment. Used for checking if the requested version of the payment is up-to-date before saving changes. This should never be manually decremented/incremented.

    • 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)

    • setBillingEventId

      public void setBillingEventId(String billingEventId)
      The BillingEvent associated with this payment

    • setPaymentProcessType

      public void setPaymentProcessType(String paymentProcessType)
      Serves as a reference to the process that's meant to collect payment for this BillingEventPayment

    • setPaymentStatus

      public void setPaymentStatus(PaymentStatusEnum paymentStatus)
      The payment status of the BillingEventPayment.
      See Also:

    • setPaymentAmount

      public void setPaymentAmount(BigDecimal paymentAmount)
      The amount to be billed on this payment.

    • setPreferredPaymentAccountId

      public void setPreferredPaymentAccountId(String preferredPaymentAccountId)
      The ID of the preferred payment account to use for this payment.

    • setRetryScheduleCode

      public void setRetryScheduleCode(String retryScheduleCode)
      The IntervalBillingRetrySpecs to use when calculating the retry date.
      Specified by:
      setRetryScheduleCode in interface RetryPayment
      See Also:

    • setNextRetryDate

      public void setNextRetryDate(Date nextRetryDate)
      In the case of a failed payment, the next date to try processing payment.
      Specified by:
      setNextRetryDate in interface RetryPayment
      See Also:

    • setRemainingRetryCount

      public void setRemainingRetryCount(Integer remainingRetryCount)
      The remaining number of tries to retry this payment.
      Specified by:
      setRemainingRetryCount in interface RetryPayment
      See Also:

    • setAttemptCount

      public void setAttemptCount(Integer attemptCount)
      The current attempt number.
      Specified by:
      setAttemptCount in interface RetryPayment
      See Also:

    • setCreatedDate

      public void setCreatedDate(Date createdDate)
      Creation date of this payment. This should not be manually set or updated.

    • setVersion

      public void setVersion(Integer version)
      The version of this payment. Used for checking if the requested version of the payment is up-to-date before saving changes. This should never be manually decremented/incremented.

    • 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