Package com.broadleafcommerce.cartoperation.domain.subscription

Class DelayedSubscriptionAction

java.lang.Object
com.broadleafcommerce.cartoperation.domain.subscription.DelayedSubscriptionAction
All Implemented Interfaces:
Serializable
public class DelayedSubscriptionAction extends Object implements Serializable
Simple object describing a subscription action that should be applied in the future.
Since:
Cart Operation Service 2.3.0, Release Train 2.3.0
Author:
Chris Kittrell (ckittrell)
See Also:

  • Constructor Details

    • DelayedSubscriptionAction

      public DelayedSubscriptionAction()

  • Method Details

    • getWorkflowName

      public String getWorkflowName()
      The name of the workflow that created this delayed action.

    • getActionFlow

      public String getActionFlow()
      The original action flow that led to the creation of this delayed action.
      See Also:

    • getSubscriptionId

      public String getSubscriptionId()
      The id of delayed action's related subscription.

    • getOrderId

      public String getOrderId()
      The id of the order that led to the creation of this delayed action.

    • getOrderFulfillmentId

      public String getOrderFulfillmentId()
      The id of the fulfillment that led to the creation of this delayed action.

    • getActionType

      public String getActionType()
      The type of delayed action that is to be performed.
      See Also:
      • DefaultDelayedSubscriptionActionType

    • getActionEffectiveType

      public String getActionEffectiveType()
      The descriptor of when the price change should take effect.
      See Also:
      • DefaultDelayedSubscriptionActionEffectiveType

    • getApplicablePeriod

      public Integer getApplicablePeriod()
      The period number on which the delayed action is due.

      For example, if getActionEffectiveType() is DefaultDelayedSubscriptionActionEffectiveType#NEXT_BILL_DATE, then this will represent the subscription's current period when the original action was requested + 1.

    • getAttributes

      public Map<String,Object> getAttributes()
      Any additional attributes used to describe the delayed action

    • setWorkflowName

      public void setWorkflowName(String workflowName)
      The name of the workflow that created this delayed action.

    • setActionFlow

      public void setActionFlow(String actionFlow)
      The original action flow that led to the creation of this delayed action.
      See Also:

    • setSubscriptionId

      public void setSubscriptionId(String subscriptionId)
      The id of delayed action's related subscription.

    • setOrderId

      public void setOrderId(String orderId)
      The id of the order that led to the creation of this delayed action.

    • setOrderFulfillmentId

      public void setOrderFulfillmentId(String orderFulfillmentId)
      The id of the fulfillment that led to the creation of this delayed action.

    • setActionType

      public void setActionType(String actionType)
      The type of delayed action that is to be performed.
      See Also:
      • DefaultDelayedSubscriptionActionType

    • setActionEffectiveType

      public void setActionEffectiveType(String actionEffectiveType)
      The descriptor of when the price change should take effect.
      See Also:
      • DefaultDelayedSubscriptionActionEffectiveType

    • setApplicablePeriod

      public void setApplicablePeriod(Integer applicablePeriod)
      The period number on which the delayed action is due.

      For example, if getActionEffectiveType() is DefaultDelayedSubscriptionActionEffectiveType#NEXT_BILL_DATE, then this will represent the subscription's current period when the original action was requested + 1.

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Any additional attributes used to describe the delayed action

    • 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