Class OrderCancelConfigModel

All Implemented Interfaces:
Serializable

public class OrderCancelConfigModel extends ItemModel
Generated model class for type OrderCancelConfig first defined at extension basecommerce.
See Also:
  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:
    • ORDERCANCELALLOWED

      public static final String ORDERCANCELALLOWED
      Generated constant - Attribute key of OrderCancelConfig.orderCancelAllowed attribute defined at extension basecommerce.
      See Also:
    • CANCELAFTERWAREHOUSEALLOWED

      public static final String CANCELAFTERWAREHOUSEALLOWED
      Generated constant - Attribute key of OrderCancelConfig.cancelAfterWarehouseAllowed attribute defined at extension basecommerce.
      See Also:
    • COMPLETECANCELAFTERSHIPPINGSTARTEDALLOWED

      public static final String COMPLETECANCELAFTERSHIPPINGSTARTEDALLOWED
      Generated constant - Attribute key of OrderCancelConfig.completeCancelAfterShippingStartedAllowed attribute defined at extension basecommerce.
      See Also:
    • PARTIALCANCELALLOWED

      public static final String PARTIALCANCELALLOWED
      Generated constant - Attribute key of OrderCancelConfig.partialCancelAllowed attribute defined at extension basecommerce.
      See Also:
    • PARTIALORDERENTRYCANCELALLOWED

      public static final String PARTIALORDERENTRYCANCELALLOWED
      Generated constant - Attribute key of OrderCancelConfig.partialOrderEntryCancelAllowed attribute defined at extension basecommerce.
      See Also:
    • QUEUEDORDERWAITINGTIME

      public static final String QUEUEDORDERWAITINGTIME
      Generated constant - Attribute key of OrderCancelConfig.queuedOrderWaitingTime attribute defined at extension basecommerce.
      See Also:
  • Constructor Details

    • OrderCancelConfigModel

      public OrderCancelConfigModel()
      Generated constructor - Default constructor for generic creation.
    • OrderCancelConfigModel

      public OrderCancelConfigModel(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      Parameters:
      ctx - the model context to be injected, must not be null
    • OrderCancelConfigModel

      @Deprecated(since="4.1.1", forRemoval=true) public OrderCancelConfigModel(boolean _cancelAfterWarehouseAllowed, boolean _completeCancelAfterShippingStartedAllowed, boolean _orderCancelAllowed, boolean _partialCancelAllowed, boolean _partialOrderEntryCancelAllowed, int _queuedOrderWaitingTime)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      Generated constructor - Constructor with all mandatory attributes.
      Parameters:
      _cancelAfterWarehouseAllowed - initial attribute declared by type OrderCancelConfig at extension basecommerce
      _completeCancelAfterShippingStartedAllowed - initial attribute declared by type OrderCancelConfig at extension basecommerce
      _orderCancelAllowed - initial attribute declared by type OrderCancelConfig at extension basecommerce
      _partialCancelAllowed - initial attribute declared by type OrderCancelConfig at extension basecommerce
      _partialOrderEntryCancelAllowed - initial attribute declared by type OrderCancelConfig at extension basecommerce
      _queuedOrderWaitingTime - initial attribute declared by type OrderCancelConfig at extension basecommerce
    • OrderCancelConfigModel

      @Deprecated(since="4.1.1", forRemoval=true) public OrderCancelConfigModel(boolean _cancelAfterWarehouseAllowed, boolean _completeCancelAfterShippingStartedAllowed, boolean _orderCancelAllowed, ItemModel _owner, boolean _partialCancelAllowed, boolean _partialOrderEntryCancelAllowed, int _queuedOrderWaitingTime)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      Generated constructor - for all mandatory and initial attributes.
      Parameters:
      _cancelAfterWarehouseAllowed - initial attribute declared by type OrderCancelConfig at extension basecommerce
      _completeCancelAfterShippingStartedAllowed - initial attribute declared by type OrderCancelConfig at extension basecommerce
      _orderCancelAllowed - initial attribute declared by type OrderCancelConfig at extension basecommerce
      _owner - initial attribute declared by type Item at extension core
      _partialCancelAllowed - initial attribute declared by type OrderCancelConfig at extension basecommerce
      _partialOrderEntryCancelAllowed - initial attribute declared by type OrderCancelConfig at extension basecommerce
      _queuedOrderWaitingTime - initial attribute declared by type OrderCancelConfig at extension basecommerce
  • Method Details

    • getQueuedOrderWaitingTime

      @Accessor(qualifier="queuedOrderWaitingTime", type=GETTER) public int getQueuedOrderWaitingTime()
      Generated method - Getter of the OrderCancelConfig.queuedOrderWaitingTime attribute defined at extension basecommerce.
      Returns:
      the queuedOrderWaitingTime - Determines how long an order should wait in queue before it's started to be fullfilled
    • isCancelAfterWarehouseAllowed

      @Accessor(qualifier="cancelAfterWarehouseAllowed", type=GETTER) public boolean isCancelAfterWarehouseAllowed()
      Generated method - Getter of the OrderCancelConfig.cancelAfterWarehouseAllowed attribute defined at extension basecommerce.
      Returns:
      the cancelAfterWarehouseAllowed - Determines if the order cancelling is still possible after sending it to warehouse
    • isCompleteCancelAfterShippingStartedAllowed

      @Accessor(qualifier="completeCancelAfterShippingStartedAllowed", type=GETTER) public boolean isCompleteCancelAfterShippingStartedAllowed()
      Generated method - Getter of the OrderCancelConfig.completeCancelAfterShippingStartedAllowed attribute defined at extension basecommerce.
      Returns:
      the completeCancelAfterShippingStartedAllowed - Determines if a complete cancel request is allowed after shipping has been started. This means: Cancel the part of the order that has not been shipped yet. Evaluated only if cancelAfterWarehouseAllowed is true.
    • isOrderCancelAllowed

      @Accessor(qualifier="orderCancelAllowed", type=GETTER) public boolean isOrderCancelAllowed()
      Generated method - Getter of the OrderCancelConfig.orderCancelAllowed attribute defined at extension basecommerce.
      Returns:
      the orderCancelAllowed - Determines if the order cancelling is at all possible
    • isPartialCancelAllowed

      @Accessor(qualifier="partialCancelAllowed", type=GETTER) public boolean isPartialCancelAllowed()
      Generated method - Getter of the OrderCancelConfig.partialCancelAllowed attribute defined at extension basecommerce.
      Returns:
      the partialCancelAllowed - Determines if the partial order cancelling (discarding whole order entries) is possible.
    • isPartialOrderEntryCancelAllowed

      @Accessor(qualifier="partialOrderEntryCancelAllowed", type=GETTER) public boolean isPartialOrderEntryCancelAllowed()
      Generated method - Getter of the OrderCancelConfig.partialOrderEntryCancelAllowed attribute defined at extension basecommerce.
      Returns:
      the partialOrderEntryCancelAllowed - Determines if the partial order entry cancelling (discarding parts of order entries) is possible. This parameter is evaluated only if partialCancelAllowed is set to true.
    • setCancelAfterWarehouseAllowed

      @Accessor(qualifier="cancelAfterWarehouseAllowed", type=SETTER) public void setCancelAfterWarehouseAllowed(boolean value)
      Generated method - Setter of OrderCancelConfig.cancelAfterWarehouseAllowed attribute defined at extension basecommerce.
      Parameters:
      value - the cancelAfterWarehouseAllowed - Determines if the order cancelling is still possible after sending it to warehouse
    • setCompleteCancelAfterShippingStartedAllowed

      @Accessor(qualifier="completeCancelAfterShippingStartedAllowed", type=SETTER) public void setCompleteCancelAfterShippingStartedAllowed(boolean value)
      Generated method - Setter of OrderCancelConfig.completeCancelAfterShippingStartedAllowed attribute defined at extension basecommerce.
      Parameters:
      value - the completeCancelAfterShippingStartedAllowed - Determines if a complete cancel request is allowed after shipping has been started. This means: Cancel the part of the order that has not been shipped yet. Evaluated only if cancelAfterWarehouseAllowed is true.
    • setOrderCancelAllowed

      @Accessor(qualifier="orderCancelAllowed", type=SETTER) public void setOrderCancelAllowed(boolean value)
      Generated method - Setter of OrderCancelConfig.orderCancelAllowed attribute defined at extension basecommerce.
      Parameters:
      value - the orderCancelAllowed - Determines if the order cancelling is at all possible
    • setPartialCancelAllowed

      @Accessor(qualifier="partialCancelAllowed", type=SETTER) public void setPartialCancelAllowed(boolean value)
      Generated method - Setter of OrderCancelConfig.partialCancelAllowed attribute defined at extension basecommerce.
      Parameters:
      value - the partialCancelAllowed - Determines if the partial order cancelling (discarding whole order entries) is possible.
    • setPartialOrderEntryCancelAllowed

      @Accessor(qualifier="partialOrderEntryCancelAllowed", type=SETTER) public void setPartialOrderEntryCancelAllowed(boolean value)
      Generated method - Setter of OrderCancelConfig.partialOrderEntryCancelAllowed attribute defined at extension basecommerce.
      Parameters:
      value - the partialOrderEntryCancelAllowed - Determines if the partial order entry cancelling (discarding parts of order entries) is possible. This parameter is evaluated only if partialCancelAllowed is set to true.
    • setQueuedOrderWaitingTime

      @Accessor(qualifier="queuedOrderWaitingTime", type=SETTER) public void setQueuedOrderWaitingTime(int value)
      Generated method - Setter of OrderCancelConfig.queuedOrderWaitingTime attribute defined at extension basecommerce.
      Parameters:
      value - the queuedOrderWaitingTime - Determines how long an order should wait in queue before it's started to be fullfilled