Package de.hybris.platform.ordercancel.model

Class OrderCancelConfigModel

  • All Implemented Interfaces:
    java.io.Serializable
    public class OrderCancelConfigModel
extends ItemModel
    Generated model class for type OrderCancelConfig first defined at extension basecommerce.
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        de.hybris.platform.servicelayer.model.AbstractItemModel.NewModelContextFactory

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String CANCELAFTERWAREHOUSEALLOWED
      Generated constant - Attribute key of OrderCancelConfig.cancelAfterWarehouseAllowed attribute defined at extension basecommerce.
      static java.lang.String COMPLETECANCELAFTERSHIPPINGSTARTEDALLOWED
      Generated constant - Attribute key of OrderCancelConfig.completeCancelAfterShippingStartedAllowed attribute defined at extension basecommerce.
      static java.lang.String ORDERCANCELALLOWED
      Generated constant - Attribute key of OrderCancelConfig.orderCancelAllowed attribute defined at extension basecommerce.
      static java.lang.String PARTIALCANCELALLOWED
      Generated constant - Attribute key of OrderCancelConfig.partialCancelAllowed attribute defined at extension basecommerce.
      static java.lang.String PARTIALORDERENTRYCANCELALLOWED
      Generated constant - Attribute key of OrderCancelConfig.partialOrderEntryCancelAllowed attribute defined at extension basecommerce.
      static java.lang.String QUEUEDORDERWAITINGTIME
      Generated constant - Attribute key of OrderCancelConfig.queuedOrderWaitingTime attribute defined at extension basecommerce.

      • Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

    • Constructor Summary

      Constructors 
      Constructor Description
      OrderCancelConfigModel()
      Generated constructor - Default constructor for generic creation.
      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
      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
      OrderCancelConfigModel​(de.hybris.platform.servicelayer.model.ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getQueuedOrderWaitingTime()
      Generated method - Getter of the OrderCancelConfig.queuedOrderWaitingTime attribute defined at extension basecommerce.
      boolean isCancelAfterWarehouseAllowed()
      Generated method - Getter of the OrderCancelConfig.cancelAfterWarehouseAllowed attribute defined at extension basecommerce.
      boolean isCompleteCancelAfterShippingStartedAllowed()
      Generated method - Getter of the OrderCancelConfig.completeCancelAfterShippingStartedAllowed attribute defined at extension basecommerce.
      boolean isOrderCancelAllowed()
      Generated method - Getter of the OrderCancelConfig.orderCancelAllowed attribute defined at extension basecommerce.
      boolean isPartialCancelAllowed()
      Generated method - Getter of the OrderCancelConfig.partialCancelAllowed attribute defined at extension basecommerce.
      boolean isPartialOrderEntryCancelAllowed()
      Generated method - Getter of the OrderCancelConfig.partialOrderEntryCancelAllowed attribute defined at extension basecommerce.
      void setCancelAfterWarehouseAllowed​(boolean value)
      Generated method - Setter of OrderCancelConfig.cancelAfterWarehouseAllowed attribute defined at extension basecommerce.
      void setCompleteCancelAfterShippingStartedAllowed​(boolean value)
      Generated method - Setter of OrderCancelConfig.completeCancelAfterShippingStartedAllowed attribute defined at extension basecommerce.
      void setOrderCancelAllowed​(boolean value)
      Generated method - Setter of OrderCancelConfig.orderCancelAllowed attribute defined at extension basecommerce.
      void setPartialCancelAllowed​(boolean value)
      Generated method - Setter of OrderCancelConfig.partialCancelAllowed attribute defined at extension basecommerce.
      void setPartialOrderEntryCancelAllowed​(boolean value)
      Generated method - Setter of OrderCancelConfig.partialOrderEntryCancelAllowed attribute defined at extension basecommerce.
      void setQueuedOrderWaitingTime​(int value)
      Generated method - Setter of OrderCancelConfig.queuedOrderWaitingTime attribute defined at extension basecommerce.

      • Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

        equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values

      • ORDERCANCELALLOWED

        public static final java.lang.String ORDERCANCELALLOWED
        Generated constant - Attribute key of OrderCancelConfig.orderCancelAllowed attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • CANCELAFTERWAREHOUSEALLOWED

        public static final java.lang.String CANCELAFTERWAREHOUSEALLOWED
        Generated constant - Attribute key of OrderCancelConfig.cancelAfterWarehouseAllowed attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • COMPLETECANCELAFTERSHIPPINGSTARTEDALLOWED

        public static final java.lang.String COMPLETECANCELAFTERSHIPPINGSTARTEDALLOWED
        Generated constant - Attribute key of OrderCancelConfig.completeCancelAfterShippingStartedAllowed attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • PARTIALCANCELALLOWED

        public static final java.lang.String PARTIALCANCELALLOWED
        Generated constant - Attribute key of OrderCancelConfig.partialCancelAllowed attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • PARTIALORDERENTRYCANCELALLOWED

        public static final java.lang.String PARTIALORDERENTRYCANCELALLOWED
        Generated constant - Attribute key of OrderCancelConfig.partialOrderEntryCancelAllowed attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

      • QUEUEDORDERWAITINGTIME

        public static final java.lang.String QUEUEDORDERWAITINGTIME
        Generated constant - Attribute key of OrderCancelConfig.queuedOrderWaitingTime attribute defined at extension basecommerce.
        See Also:
        Constant Field Values

    • Constructor Detail

      • OrderCancelConfigModel

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

      • OrderCancelConfigModel

        public OrderCancelConfigModel​(de.hybris.platform.servicelayer.model.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 Detail

      • 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