Package com.broadleafcommerce.subscriptionoperation.domain

Class SubscriptionWithItems

java.lang.Object
com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems
All Implemented Interfaces:
Serializable
public class SubscriptionWithItems extends Object implements Serializable
This is a container for a Subscription and a list of SubscriptionItem
See Also:

  • Constructor Details

    • SubscriptionWithItems

      public SubscriptionWithItems()

    • SubscriptionWithItems

      public SubscriptionWithItems(Subscription subscription, List<SubscriptionItem> subscriptionItems, List<SubscriptionAction> availableActions, Map<String,List<String>> unavailableReasonsByActionType, SubscriptionReferencedItem rootItem, CancellationPolicy cancellationPolicy, Map<String,Object> additionalAttributes)
      Creates a new SubscriptionWithItems instance.
      Parameters:
      subscription -
      subscriptionItems -
      availableActions - The available SubscriptionActions that may be possible for this subscription.
      unavailableReasonsByActionType - The unavailable SubscriptionActionTypes along with unavailable reasons for this subscription.
      rootItem - The item referenced by Subscription.getRootItemRef(). This is hydrated in some flows in the business logic rather than by the caller. It should not be serialized.
      cancellationPolicy - Describes details for access & charges in the current period in which the cancellation of this subscription is being requested/executed. It should not be serialized.
      additionalAttributes - Map holding any additional attributes passed in the request not matching any defined properties.

  • Method Details

    • setSubscriptionId

      public void setSubscriptionId(String subscriptionId)

    • getSubscriptionId

      public String getSubscriptionId()

    • addAdditionalAttribute

      public void addAdditionalAttribute(String name, Object value)
      Takes in any additional attributes passed in the request not matching any defined properties.
      Parameters:
      name - Name of the additional attribute
      value - Value of the additional attribute

    • getAdditionalAttribute

      public Map<String,Object> getAdditionalAttribute()
      Return any additional attributes passed in the request not matching any defined properties.
      Returns:
      any additional attributes passed in the request not matching any defined properties.

    • getSubscription

      public Subscription getSubscription()

    • getSubscriptionItems

      public List<SubscriptionItem> getSubscriptionItems()

    • getAvailableActions

      public List<SubscriptionAction> getAvailableActions()
      The available SubscriptionActions that may be possible for this subscription.

    • getUnavailableReasonsByActionType

      public Map<String,List<String>> getUnavailableReasonsByActionType()
      The unavailable SubscriptionActionTypes along with unavailable reasons for this subscription.

    • getRootItem

      public SubscriptionReferencedItem getRootItem()
      The item referenced by Subscription.getRootItemRef(). This is hydrated in some flows in the business logic rather than by the caller. It should not be serialized.

    • getCancellationPolicy

      public CancellationPolicy getCancellationPolicy()
      Describes details for access & charges in the current period in which the cancellation of this subscription is being requested/executed. It should not be serialized.

    • getAdditionalAttributes

      public Map<String,Object> getAdditionalAttributes()
      Map holding any additional attributes passed in the request not matching any defined properties.

    • setSubscription

      public void setSubscription(Subscription subscription)

    • setSubscriptionItems

      public void setSubscriptionItems(List<SubscriptionItem> subscriptionItems)

    • setAvailableActions

      public void setAvailableActions(List<SubscriptionAction> availableActions)
      The available SubscriptionActions that may be possible for this subscription.

    • setUnavailableReasonsByActionType

      public void setUnavailableReasonsByActionType(Map<String,List<String>> unavailableReasonsByActionType)
      The unavailable SubscriptionActionTypes along with unavailable reasons for this subscription.

    • setRootItem

      public void setRootItem(SubscriptionReferencedItem rootItem)
      The item referenced by Subscription.getRootItemRef(). This is hydrated in some flows in the business logic rather than by the caller. It should not be serialized.

    • setCancellationPolicy

      public void setCancellationPolicy(CancellationPolicy cancellationPolicy)
      Describes details for access & charges in the current period in which the cancellation of this subscription is being requested/executed. It should not be serialized.

    • setAdditionalAttributes

      public void setAdditionalAttributes(Map<String,Object> additionalAttributes)
      Map holding any additional attributes passed in the request not matching any defined properties.

    • 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