java.lang.Object
- org.compiere.model.PO
- - org.compiere.model.X_M_StorageOnHand
  - - org.compiere.model.MStorageOnHand

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_M_StorageOnHand, I_Persistent, Evaluatee
```
public class MStorageOnHand
extends X_M_StorageOnHand
```
Inventory Storage Model

Version:

$Id: MStorageOnHand.java,v 1.3 2006/07/30 00:51:05 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.compiere.model.PO
  ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID
- Fields inherited from interface org.compiere.model.I_M_StorageOnHand
  accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_DateLastInventory, COLUMNNAME_DateMaterialPolicy, COLUMNNAME_IsActive, COLUMNNAME_M_AttributeSetInstance_ID, COLUMNNAME_M_Locator_ID, COLUMNNAME_M_Product_ID, COLUMNNAME_M_StorageOnHand_UU, COLUMNNAME_QtyOnHand, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors
Constructor	Description
`MStorageOnHand(Properties ctx, int ignored, String trxName)`	Persistency Constructor
`MStorageOnHand(Properties ctx, ResultSet rs, String trxName)`	Load Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static boolean`	`add(Properties ctx, int M_Warehouse_ID, int M_Locator_ID, int M_Product_ID, int M_AttributeSetInstance_ID, BigDecimal diffQtyOnHand, String trxName)`	Deprecated.
`static boolean`	`add(Properties ctx, int M_Warehouse_ID, int M_Locator_ID, int M_Product_ID, int M_AttributeSetInstance_ID, BigDecimal diffQtyOnHand, Timestamp dateMPolicy, String trxName)`	Deprecated.
`static boolean`	`add(Properties ctx, int M_Locator_ID, int M_Product_ID, int M_AttributeSetInstance_ID, BigDecimal diffQtyOnHand, Timestamp dateMPolicy, String trxName)`	Update Storage Info add.
`void`	`addQtyOnHand(BigDecimal addition)`	Add quantity on hand directly - not using cached value - solving IDEMPIERE-2629
`protected boolean`	`beforeSave(boolean newRecord)`	Before Save
`static MStorageOnHand`	`get(Properties ctx, int M_Locator_ID, int M_Product_ID, int M_AttributeSetInstance_ID, String trxName)`	Deprecated.
`static MStorageOnHand`	`get(Properties ctx, int M_Locator_ID, int M_Product_ID, int M_AttributeSetInstance_ID, Timestamp dateMPolicy, String trxName)`	Get Storage Info
`static MStorageOnHand[]`	`getAll(Properties ctx, int M_Product_ID, int M_Locator_ID, boolean locatorPriority, boolean fifo, String trxName, boolean forUpdate, int timeout)`	Get all Storages for Product where QtyOnHand <> 0
`static MStorageOnHand[]`	`getAll(Properties ctx, int M_Product_ID, int M_Locator_ID, String trxName)`	Get all Storages for Product where QtyOnHand <> 0
`static MStorageOnHand[]`	`getAll(Properties ctx, int M_Product_ID, int M_Locator_ID, String trxName, boolean forUpdate, int timeout)`	Get all Storages for Product where QtyOnHand <> 0
`static MStorageOnHand[]`	`getAllWithASI(Properties ctx, int M_Product_ID, int M_Locator_ID, boolean FiFo, String trxName)`	Get all Storages for Product with ASI and QtyOnHand <> 0
`static MStorageOnHand`	`getCreate(Properties ctx, int M_Locator_ID, int M_Product_ID, int M_AttributeSetInstance_ID, Timestamp dateMPolicy, String trxName)`	Create or Get Storage Info
`static MStorageOnHand`	`getCreate(Properties ctx, int M_Locator_ID, int M_Product_ID, int M_AttributeSetInstance_ID, Timestamp dateMPolicy, String trxName, boolean forUpdate)`	Create or Get Storage Info
`static MStorageOnHand`	`getCreate(Properties ctx, int M_Locator_ID, int M_Product_ID, int M_AttributeSetInstance_ID, Timestamp dateMPolicy, String trxName, boolean forUpdate, int timeout)`	Create or Get Storage Info
`static Timestamp`	`getDateMaterialPolicy(int M_Product_ID, int M_AttributeSetInstance_ID, int M_Locator_ID, String trxName)`
`static Timestamp`	`getDateMaterialPolicy(int M_Product_ID, int M_AttributeSetInstance_ID, String trxName)`
`static int`	`getM_Locator_ID(int M_Warehouse_ID, int M_Product_ID, int M_AttributeSetInstance_ID, BigDecimal Qty, String trxName)`	Get Location with highest Locator Priority and a sufficient OnHand Qty
`int`	`getM_Warehouse_ID()`	Get M_Warehouse_ID of Locator
`static MStorageOnHand[]`	`getOfProduct(Properties ctx, int M_Product_ID, String trxName)`	Get Storage Info for Product across warehouses
`static BigDecimal`	`getQtyOnHand(int M_Product_ID, int M_Warehouse_ID, int M_AttributeSetInstance_ID, String trxName)`	Get Quantity On Hand of Warehouse
`static BigDecimal`	`getQtyOnHandForLocator(int M_Product_ID, int M_Locator_ID, int M_AttributeSetInstance_ID, String trxName)`	Get Quantity On Hand of Locator
`static BigDecimal`	`getQtyOnHandForLocatorWithASIZero(int M_Product_ID, int M_Locator_ID, String trxName)`	Get Quantity On Hand of Locator wtih ASI=0
`static BigDecimal`	`getQtyOnHandForReservation(int M_Product_ID, int M_Warehouse_ID, int M_AttributeSetInstance_ID, String trxName)`	Get Quantity On Hand of Warehouse Available for Reservation
`static BigDecimal`	`getQtyOnHandForReservationWithASIZero(int M_Product_ID, int M_Warehouse_ID, String trxName)`	Get Quantity On Hand of Warehouse Available for Reservation with ASI=0
`static BigDecimal`	`getQtyOnHandForShipping(int M_Product_ID, int M_Warehouse_ID, int M_AttributeSetInstance_ID, String trxName)`	Get Quantity On Hand of Warehouse that's available for shipping
`static BigDecimal`	`getQtyOnHandForShippingWithASIZero(int M_Product_ID, int M_Warehouse_ID, String trxName)`	Get Quantity On Hand of Warehouse that's available for shipping with ASI=0
`static BigDecimal`	`getQtyOnHandWithASIZero(int M_Product_ID, int M_Warehouse_ID, String trxName)`	Get Quantity On Hand of Warehouse with ASI=0
`static MStorageOnHand[]`	`getWarehouse(Properties ctx, int M_Warehouse_ID, int M_Product_ID, int M_AttributeSetInstance_ID, int M_AttributeSet_ID, boolean allAttributeInstances, Timestamp minGuaranteeDate, boolean FiFo, String trxName)`	Deprecated.
`static MStorageOnHand[]`	`getWarehouse(Properties ctx, int M_Warehouse_ID, int M_Product_ID, int M_AttributeSetInstance_ID, Timestamp minGuaranteeDate, boolean FiFo, boolean positiveOnly, int M_Locator_ID, String trxName)`	Get Storage Info for Warehouse or locator
`static MStorageOnHand[]`	`getWarehouse(Properties ctx, int M_Warehouse_ID, int M_Product_ID, int M_AttributeSetInstance_ID, Timestamp minGuaranteeDate, boolean FiFo, boolean positiveOnly, int M_Locator_ID, String trxName, boolean forUpdate)`	Get Storage Info for Warehouse or locator
`static MStorageOnHand[]`	`getWarehouse(Properties ctx, int M_Warehouse_ID, int M_Product_ID, int M_AttributeSetInstance_ID, Timestamp minGuaranteeDate, boolean FiFo, boolean positiveOnly, int M_Locator_ID, String trxName, boolean forUpdate, int timeout)`	Get Storage Info for Warehouse or locator
`static MStorageOnHand[]`	`getWarehouseNegative(Properties ctx, int M_Warehouse_ID, int M_Product_ID, int M_AttributeSetInstance_ID, Timestamp minGuaranteeDate, boolean FiFo, int M_Locator_ID, String trxName)`	Get Storage Info for Warehouse or locator
`static MStorageOnHand[]`	`getWarehouseNegative(Properties ctx, int M_Warehouse_ID, int M_Product_ID, int M_AttributeSetInstance_ID, Timestamp minGuaranteeDate, boolean FiFo, int M_Locator_ID, String trxName, boolean forUpdate)`	Get Storage Info for Warehouse or locator
`static MStorageOnHand[]`	`getWarehouseNegative(Properties ctx, int M_Warehouse_ID, int M_Product_ID, int M_AttributeSetInstance_ID, Timestamp minGuaranteeDate, boolean FiFo, int M_Locator_ID, String trxName, boolean forUpdate, int timeout)`	Get Storage Info for Warehouse or locator
`String`	`toString()`	String Representation

Methods inherited from class org.compiere.model.PO
afterDelete, afterSave, beforeDelete, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_M_StorageOnHand
getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent
save

Constructor Detail

MStorageOnHand

public MStorageOnHand(Properties ctx,
                      int ignored,
                      String trxName)

Persistency Constructor

Parameters:: ctx - context; ignored - ignored; trxName - transaction

MStorageOnHand

public MStorageOnHand(Properties ctx,
                      ResultSet rs,
                      String trxName)

Load Constructor

Parameters:: ctx - context; rs - result set; trxName - transaction

Method Detail

get

public static MStorageOnHand get(Properties ctx,
                                 int M_Locator_ID,
                                 int M_Product_ID,
                                 int M_AttributeSetInstance_ID,
                                 String trxName)

Deprecated.

Parameters:: ctx -; M_Locator_ID -; M_Product_ID -; M_AttributeSetInstance_ID -; trxName -
Returns:: MStorageOnHand

get

public static MStorageOnHand get(Properties ctx,
                                 int M_Locator_ID,
                                 int M_Product_ID,
                                 int M_AttributeSetInstance_ID,
                                 Timestamp dateMPolicy,
                                 String trxName)

Get Storage Info

Parameters:: ctx - context; M_Locator_ID - locator; M_Product_ID - product; M_AttributeSetInstance_ID - instance; dateMPolicy -; trxName - transaction
Returns:: existing or null

getAllWithASI

public static MStorageOnHand[] getAllWithASI(Properties ctx,
                                             int M_Product_ID,
                                             int M_Locator_ID,
                                             boolean FiFo,
                                             String trxName)

Get all Storages for Product with ASI and QtyOnHand <> 0

Parameters:: ctx - context; M_Product_ID - product; M_Locator_ID - locator; FiFo - first in-first-out; trxName - transaction
Returns:: existing or null

getAll

public static MStorageOnHand[] getAll(Properties ctx,
                                      int M_Product_ID,
                                      int M_Locator_ID,
                                      String trxName)

Get all Storages for Product where QtyOnHand <> 0

Parameters:: ctx - context; M_Product_ID - product; M_Locator_ID - locator, 0 to match all locator; trxName - transaction
Returns:: existing or null

getAll

public static MStorageOnHand[] getAll(Properties ctx,
                                      int M_Product_ID,
                                      int M_Locator_ID,
                                      String trxName,
                                      boolean forUpdate,
                                      int timeout)

Get all Storages for Product where QtyOnHand <> 0

Parameters:: ctx - context; M_Product_ID - product; M_Locator_ID - locator, 0 to match all locator; trxName - transaction; forUpdate -; timeout -
Returns:: existing or null

getAll

public static MStorageOnHand[] getAll(Properties ctx,
                                      int M_Product_ID,
                                      int M_Locator_ID,
                                      boolean locatorPriority,
                                      boolean fifo,
                                      String trxName,
                                      boolean forUpdate,
                                      int timeout)

Get all Storages for Product where QtyOnHand <> 0

Parameters:: ctx - context; M_Product_ID - product; M_Locator_ID - locator, 0 to match all locator; locatorPriority - If true, sort descending by locator Priority No; fifo - Sort ascending(fifo) or descending(lifo) by date material policy, m_attributesetinstance_id; trxName - transaction; forUpdate - If true, acquire db lock for update; timeout - timeout for the acquisition of db update lock
Returns:: existing or null

getOfProduct

public static MStorageOnHand[] getOfProduct(Properties ctx,
                                            int M_Product_ID,
                                            String trxName)

Get Storage Info for Product across warehouses

Parameters:: ctx - context; M_Product_ID - product; trxName - transaction
Returns:: existing or null

getWarehouse

public static MStorageOnHand[] getWarehouse(Properties ctx,
                                            int M_Warehouse_ID,
                                            int M_Product_ID,
                                            int M_AttributeSetInstance_ID,
                                            int M_AttributeSet_ID,
                                            boolean allAttributeInstances,
                                            Timestamp minGuaranteeDate,
                                            boolean FiFo,
                                            String trxName)

Deprecated.

Get Storage Info for Warehouse

Parameters:: ctx - context; M_Warehouse_ID -; M_Product_ID - product; M_AttributeSetInstance_ID - instance; M_AttributeSet_ID - attribute set (NOT USED); allAttributeInstances - if true, all attribute set instances (NOT USED); minGuaranteeDate - optional minimum guarantee date if all attribute instances; FiFo - first in-first-out; trxName - transaction
Returns:: existing - ordered by location priority (desc) and/or guarantee date