Package com.broadleafcommerce.subscriptionoperation.web.domain

Class BulkPriceUpdateSubscriptionRequest

java.lang.Object
com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest
All Implemented Interfaces:
Serializable
public class BulkPriceUpdateSubscriptionRequest extends Object implements Serializable
A DTO used to engage bulk update of pricing on all subscriptions identified as in-scope.
See Also:

  • Constructor Details

    • BulkPriceUpdateSubscriptionRequest

      public BulkPriceUpdateSubscriptionRequest()

  • Method Details

    • getReference

      public String getReference()
      An idempotency key that can be used to identify repeated requests

    • getPriceDataId

      public String getPriceDataId()
      The id of the updated price data tied to one or more subscriptions.

    • getBeforeRecurringPrice

      public BigDecimal getBeforeRecurringPrice()
      The PriceData recurringPrice before the price change.

    • getAfterRecurringPrice

      public BigDecimal getAfterRecurringPrice()
      The PriceData recurringPrice after the price change.

    • getPriceChangeEffectiveType

      public String getPriceChangeEffectiveType()
      Describes how the effective date of a subscription price change should be determined.
      See Also:

    • getPriceChangeScopeType

      public String getPriceChangeScopeType()
      Represents the default types of customer scope for which subscription bulk price changes can be applied.
      See Also:

    • getPriceChangeEffectiveDate

      public Instant getPriceChangeEffectiveDate()
      The effective date of the price change. Reserved for future use.

    • getIncludedSegments

      public Set<String> getIncludedSegments()
      The segments that identify the accounts whose subscriptions should be updated. Only applicable when priceChangeScopeType is set to DefaultPriceChangeScopeType.SEGMENTS.

    • getExcludedSegments

      public Set<String> getExcludedSegments()
      The segments that identify the accounts whose subscriptions should be excluded from those identified by includedSegments. Only applicable when priceChangeScopeType is set to DefaultPriceChangeScopeType.SEGMENTS.

    • setReference

      public void setReference(String reference)
      An idempotency key that can be used to identify repeated requests

    • setPriceDataId

      public void setPriceDataId(String priceDataId)
      The id of the updated price data tied to one or more subscriptions.

    • setBeforeRecurringPrice

      public void setBeforeRecurringPrice(BigDecimal beforeRecurringPrice)
      The PriceData recurringPrice before the price change.

    • setAfterRecurringPrice

      public void setAfterRecurringPrice(BigDecimal afterRecurringPrice)
      The PriceData recurringPrice after the price change.

    • setPriceChangeEffectiveType

      public void setPriceChangeEffectiveType(String priceChangeEffectiveType)
      Describes how the effective date of a subscription price change should be determined.
      See Also:

    • setPriceChangeScopeType

      public void setPriceChangeScopeType(String priceChangeScopeType)
      Represents the default types of customer scope for which subscription bulk price changes can be applied.
      See Also:

    • setPriceChangeEffectiveDate

      public void setPriceChangeEffectiveDate(Instant priceChangeEffectiveDate)
      The effective date of the price change. Reserved for future use.

    • setIncludedSegments

      public void setIncludedSegments(Set<String> includedSegments)
      The segments that identify the accounts whose subscriptions should be updated. Only applicable when priceChangeScopeType is set to DefaultPriceChangeScopeType.SEGMENTS.

    • setExcludedSegments

      public void setExcludedSegments(Set<String> excludedSegments)
      The segments that identify the accounts whose subscriptions should be excluded from those identified by includedSegments. Only applicable when priceChangeScopeType is set to DefaultPriceChangeScopeType.SEGMENTS.

    • 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