Magento Extensions Rating 2024
Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
StockItemConfigurationInterface Interface Reference
Inheritance diagram for StockItemConfigurationInterface:
ExtensibleDataInterface StockItemConfiguration

Public Member Functions

 isQtyDecimal ()
 
 setIsQtyDecimal (bool $isQtyDecimal)
 
 isShowDefaultNotificationMessage ()
 
 isUseConfigMinQty ()
 
 setUseConfigMinQty (bool $useConfigMinQty)
 
 getMinQty ()
 
 setMinQty (float $minQty)
 
 isUseConfigMinSaleQty ()
 
 setUseConfigMinSaleQty (bool $useConfigMinSaleQty)
 
 getMinSaleQty ()
 
 setMinSaleQty (float $minSaleQty)
 
 isUseConfigMaxSaleQty ()
 
 setUseConfigMaxSaleQty (bool $useConfigMaxSaleQty)
 
 getMaxSaleQty ()
 
 setMaxSaleQty (float $maxSaleQty)
 
 isUseConfigBackorders ()
 
 setUseConfigBackorders (bool $useConfigBackorders)
 
 getBackorders ()
 
 setBackorders (int $backOrders)
 
 isUseConfigNotifyStockQty ()
 
 setUseConfigNotifyStockQty (bool $useConfigNotifyStockQty)
 
 getNotifyStockQty ()
 
 setNotifyStockQty (float $notifyStockQty)
 
 isUseConfigQtyIncrements ()
 
 setUseConfigQtyIncrements (bool $useConfigQtyIncrements)
 
 getQtyIncrements ()
 
 setQtyIncrements (float $qtyIncrements)
 
 isUseConfigEnableQtyInc ()
 
 setUseConfigEnableQtyInc (bool $useConfigEnableQtyInc)
 
 isEnableQtyIncrements ()
 
 setEnableQtyIncrements (bool $enableQtyIncrements)
 
 isUseConfigManageStock ()
 
 setUseConfigManageStock (bool $useConfigManageStock)
 
 isManageStock ()
 
 setManageStock (bool $manageStock)
 
 getLowStockDate ()
 
 setLowStockDate (string $lowStockDate)
 
 isDecimalDivided ()
 
 setIsDecimalDivided (bool $isDecimalDivided)
 
 getStockStatusChangedAuto ()
 
 setStockStatusChangedAuto (int $stockStatusChangedAuto)
 
 getStockThresholdQty ()
 
 getExtensionAttributes ()
 
 setExtensionAttributes (\Magento\InventoryConfigurationApi\Api\Data\StockItemConfigurationExtensionInterface $extensionAttributes)
 

Data Fields

const BACKORDERS_NO = 0
 
const BACKORDERS_YES_NONOTIFY = 1
 
const BACKORDERS_YES_NOTIFY = 2
 
const IS_QTY_DECIMAL = 'is_qty_decimal'
 
const SHOW_DEFAULT_NOTIFICATION_MESSAGE = 'show_default_notification_message'
 
const USE_CONFIG_MIN_QTY = 'use_config_min_qty'
 
const MIN_QTY = 'min_qty'
 
const USE_CONFIG_STOCK_THRESHOLD_QTY = 'use_config_stock_threshold_qty'
 
const STOCK_THRESHOLD_QTY = 'stock_threshold_qty'
 
const USE_CONFIG_MIN_SALE_QTY = 'use_config_min_sale_qty'
 
const MIN_SALE_QTY = 'min_sale_qty'
 
const USE_CONFIG_MAX_SALE_QTY = 'use_config_max_sale_qty'
 
const MAX_SALE_QTY = 'max_sale_qty'
 
const USE_CONFIG_BACKORDERS = 'use_config_backorders'
 
const BACKORDERS = 'backorders'
 
const USE_CONFIG_NOTIFY_STOCK_QTY = 'use_config_notify_stock_qty'
 
const NOTIFY_STOCK_QTY = 'notify_stock_qty'
 
const USE_CONFIG_QTY_INCREMENTS = 'use_config_qty_increments'
 
const QTY_INCREMENTS = 'qty_increments'
 
const USE_CONFIG_ENABLE_QTY_INC = 'use_config_enable_qty_inc'
 
const ENABLE_QTY_INCREMENTS = 'enable_qty_increments'
 
const USE_CONFIG_MANAGE_STOCK = 'use_config_manage_stock'
 
const MANAGE_STOCK = 'manage_stock'
 
const LOW_STOCK_DATE = 'low_stock_date'
 
const IS_DECIMAL_DIVIDED = 'is_decimal_divided'
 
const STOCK_STATUS_CHANGED_AUTO = 'stock_status_changed_auto'
 
- Data Fields inherited from ExtensibleDataInterface
const EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'
 

Detailed Description

@api

Definition at line 13 of file StockItemConfigurationInterface.php.

Member Function Documentation

◆ getBackorders()

getBackorders ( )

Retrieve backorders status

Returns
int

Implemented in StockItemConfiguration.

◆ getExtensionAttributes()

getExtensionAttributes ( )

Retrieve existing extension attributes object

Returns
\Magento\InventoryConfigurationApi\Api\Data\StockItemConfigurationExtensionInterface|null

Implemented in StockItemConfiguration.

◆ getLowStockDate()

getLowStockDate ( )
Returns
string

Implemented in StockItemConfiguration.

◆ getMaxSaleQty()

getMaxSaleQty ( )
Returns
float

Implemented in StockItemConfiguration.

◆ getMinQty()

getMinQty ( )
Returns
float

Implemented in StockItemConfiguration.

◆ getMinSaleQty()

getMinSaleQty ( )
Returns
float

Implemented in StockItemConfiguration.

◆ getNotifyStockQty()

getNotifyStockQty ( )
Returns
float

Implemented in StockItemConfiguration.

◆ getQtyIncrements()

getQtyIncrements ( )

Retrieve Quantity Increments data wrapper

Returns
float

Implemented in StockItemConfiguration.

◆ getStockStatusChangedAuto()

getStockStatusChangedAuto ( )
Returns
int

Implemented in StockItemConfiguration.

◆ getStockThresholdQty()

getStockThresholdQty ( )
Returns
float

Implemented in StockItemConfiguration.

◆ isDecimalDivided()

isDecimalDivided ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isEnableQtyIncrements()

isEnableQtyIncrements ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isManageStock()

isManageStock ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isQtyDecimal()

isQtyDecimal ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isShowDefaultNotificationMessage()

isShowDefaultNotificationMessage ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isUseConfigBackorders()

isUseConfigBackorders ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isUseConfigEnableQtyInc()

isUseConfigEnableQtyInc ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isUseConfigManageStock()

isUseConfigManageStock ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isUseConfigMaxSaleQty()

isUseConfigMaxSaleQty ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isUseConfigMinQty()

isUseConfigMinQty ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isUseConfigMinSaleQty()

isUseConfigMinSaleQty ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isUseConfigNotifyStockQty()

isUseConfigNotifyStockQty ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ isUseConfigQtyIncrements()

isUseConfigQtyIncrements ( )
Returns
bool

Implemented in StockItemConfiguration.

◆ setBackorders()

setBackorders ( int  $backOrders)
Parameters
int$backOrders
Returns
void

Implemented in StockItemConfiguration.

◆ setEnableQtyIncrements()

setEnableQtyIncrements ( bool  $enableQtyIncrements)
Parameters
$enableQtyIncrements
Returns
void

Implemented in StockItemConfiguration.

◆ setExtensionAttributes()

setExtensionAttributes ( \Magento\InventoryConfigurationApi\Api\Data\StockItemConfigurationExtensionInterface  $extensionAttributes)

Set an extension attributes object

Parameters
\Magento\InventoryConfigurationApi\Api\Data\StockItemConfigurationExtensionInterface$extensionAttributes
Returns
void

◆ setIsDecimalDivided()

setIsDecimalDivided ( bool  $isDecimalDivided)
Parameters
bool$isDecimalDivided
Returns
void

Implemented in StockItemConfiguration.

◆ setIsQtyDecimal()

setIsQtyDecimal ( bool  $isQtyDecimal)
Parameters
bool$isQtyDecimal
Returns
void

Implemented in StockItemConfiguration.

◆ setLowStockDate()

setLowStockDate ( string  $lowStockDate)
Parameters
string$lowStockDate
Returns
void

Implemented in StockItemConfiguration.

◆ setManageStock()

setManageStock ( bool  $manageStock)
Parameters
bool$manageStock
Returns
void

Implemented in StockItemConfiguration.

◆ setMaxSaleQty()

setMaxSaleQty ( float  $maxSaleQty)
Parameters
float$maxSaleQty
Returns
void

Implemented in StockItemConfiguration.

◆ setMinQty()

setMinQty ( float  $minQty)
Parameters
float$minQty
Returns
void

Implemented in StockItemConfiguration.

◆ setMinSaleQty()

setMinSaleQty ( float  $minSaleQty)
Parameters
float$minSaleQty
Returns
void

Implemented in StockItemConfiguration.

◆ setNotifyStockQty()

setNotifyStockQty ( float  $notifyStockQty)
Parameters
float$notifyStockQty
Returns
void

Implemented in StockItemConfiguration.

◆ setQtyIncrements()

setQtyIncrements ( float  $qtyIncrements)
Parameters
float$qtyIncrements
Returns
void

Implemented in StockItemConfiguration.

◆ setStockStatusChangedAuto()

setStockStatusChangedAuto ( int  $stockStatusChangedAuto)
Parameters
int$stockStatusChangedAuto
Returns
void

Implemented in StockItemConfiguration.

◆ setUseConfigBackorders()

setUseConfigBackorders ( bool  $useConfigBackorders)
Parameters
bool$useConfigBackorders
Returns
void

Implemented in StockItemConfiguration.

◆ setUseConfigEnableQtyInc()

setUseConfigEnableQtyInc ( bool  $useConfigEnableQtyInc)
Parameters
bool$useConfigEnableQtyInc
Returns
void

Implemented in StockItemConfiguration.

◆ setUseConfigManageStock()

setUseConfigManageStock ( bool  $useConfigManageStock)
Parameters
bool$useConfigManageStock
Returns
void

Implemented in StockItemConfiguration.

◆ setUseConfigMaxSaleQty()

setUseConfigMaxSaleQty ( bool  $useConfigMaxSaleQty)
Parameters
bool$useConfigMaxSaleQty
Returns
void

Implemented in StockItemConfiguration.

◆ setUseConfigMinQty()

setUseConfigMinQty ( bool  $useConfigMinQty)
Parameters
bool$useConfigMinQty
Returns
void

Implemented in StockItemConfiguration.

◆ setUseConfigMinSaleQty()

setUseConfigMinSaleQty ( bool  $useConfigMinSaleQty)
Parameters
bool$useConfigMinSaleQty
Returns
void

Implemented in StockItemConfiguration.

◆ setUseConfigNotifyStockQty()

setUseConfigNotifyStockQty ( bool  $useConfigNotifyStockQty)
Parameters
bool$useConfigNotifyStockQty
Returns
void

Implemented in StockItemConfiguration.

◆ setUseConfigQtyIncrements()

setUseConfigQtyIncrements ( bool  $useConfigQtyIncrements)
Parameters
bool$useConfigQtyIncrements
Returns
void

Implemented in StockItemConfiguration.

Field Documentation

◆ BACKORDERS

const BACKORDERS = 'backorders'

Definition at line 44 of file StockItemConfigurationInterface.php.

◆ BACKORDERS_NO

const BACKORDERS_NO = 0

Definition at line 15 of file StockItemConfigurationInterface.php.

◆ BACKORDERS_YES_NONOTIFY

const BACKORDERS_YES_NONOTIFY = 1

Definition at line 16 of file StockItemConfigurationInterface.php.

◆ BACKORDERS_YES_NOTIFY

const BACKORDERS_YES_NOTIFY = 2

Definition at line 17 of file StockItemConfigurationInterface.php.

◆ ENABLE_QTY_INCREMENTS

const ENABLE_QTY_INCREMENTS = 'enable_qty_increments'

Definition at line 53 of file StockItemConfigurationInterface.php.

◆ IS_DECIMAL_DIVIDED

const IS_DECIMAL_DIVIDED = 'is_decimal_divided'

Definition at line 59 of file StockItemConfigurationInterface.php.

◆ IS_QTY_DECIMAL

const IS_QTY_DECIMAL = 'is_qty_decimal'

Definition at line 19 of file StockItemConfigurationInterface.php.

◆ LOW_STOCK_DATE

const LOW_STOCK_DATE = 'low_stock_date'

Definition at line 58 of file StockItemConfigurationInterface.php.

◆ MANAGE_STOCK

const MANAGE_STOCK = 'manage_stock'

Definition at line 56 of file StockItemConfigurationInterface.php.

◆ MAX_SALE_QTY

const MAX_SALE_QTY = 'max_sale_qty'

Definition at line 41 of file StockItemConfigurationInterface.php.

◆ MIN_QTY

const MIN_QTY = 'min_qty'

Definition at line 26 of file StockItemConfigurationInterface.php.

◆ MIN_SALE_QTY

const MIN_SALE_QTY = 'min_sale_qty'

Definition at line 38 of file StockItemConfigurationInterface.php.

◆ NOTIFY_STOCK_QTY

const NOTIFY_STOCK_QTY = 'notify_stock_qty'

Definition at line 47 of file StockItemConfigurationInterface.php.

◆ QTY_INCREMENTS

const QTY_INCREMENTS = 'qty_increments'

Definition at line 50 of file StockItemConfigurationInterface.php.

◆ SHOW_DEFAULT_NOTIFICATION_MESSAGE

const SHOW_DEFAULT_NOTIFICATION_MESSAGE = 'show_default_notification_message'

Definition at line 20 of file StockItemConfigurationInterface.php.

◆ STOCK_STATUS_CHANGED_AUTO

const STOCK_STATUS_CHANGED_AUTO = 'stock_status_changed_auto'

Definition at line 60 of file StockItemConfigurationInterface.php.

◆ STOCK_THRESHOLD_QTY

const STOCK_THRESHOLD_QTY = 'stock_threshold_qty'

Definition at line 32 of file StockItemConfigurationInterface.php.

◆ USE_CONFIG_BACKORDERS

const USE_CONFIG_BACKORDERS = 'use_config_backorders'

Definition at line 43 of file StockItemConfigurationInterface.php.

◆ USE_CONFIG_ENABLE_QTY_INC

const USE_CONFIG_ENABLE_QTY_INC = 'use_config_enable_qty_inc'

Definition at line 52 of file StockItemConfigurationInterface.php.

◆ USE_CONFIG_MANAGE_STOCK

const USE_CONFIG_MANAGE_STOCK = 'use_config_manage_stock'

Definition at line 55 of file StockItemConfigurationInterface.php.

◆ USE_CONFIG_MAX_SALE_QTY

const USE_CONFIG_MAX_SALE_QTY = 'use_config_max_sale_qty'

Definition at line 40 of file StockItemConfigurationInterface.php.

◆ USE_CONFIG_MIN_QTY

const USE_CONFIG_MIN_QTY = 'use_config_min_qty'

Definition at line 25 of file StockItemConfigurationInterface.php.

◆ USE_CONFIG_MIN_SALE_QTY

const USE_CONFIG_MIN_SALE_QTY = 'use_config_min_sale_qty'

Definition at line 37 of file StockItemConfigurationInterface.php.

◆ USE_CONFIG_NOTIFY_STOCK_QTY

const USE_CONFIG_NOTIFY_STOCK_QTY = 'use_config_notify_stock_qty'

Definition at line 46 of file StockItemConfigurationInterface.php.

◆ USE_CONFIG_QTY_INCREMENTS

const USE_CONFIG_QTY_INCREMENTS = 'use_config_qty_increments'

Definition at line 49 of file StockItemConfigurationInterface.php.

◆ USE_CONFIG_STOCK_THRESHOLD_QTY

const USE_CONFIG_STOCK_THRESHOLD_QTY = 'use_config_stock_threshold_qty'

Definition at line 31 of file StockItemConfigurationInterface.php.

The documentation for this interface was generated from the following file: