Package org.compiere.model

Class MLocator

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_M_Locator

org.compiere.model.MLocator

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_M_Locator, I_Persistent, Evaluatee, ImmutablePOSupport

public class MLocator
extends X_M_Locator
implements ImmutablePOSupport

Warehouse Locator Object

Version:

$Id: MLocator.java,v 1.3 2006/07/30 00:58:37 jjanke Exp $

Author:

Jorg Janke, victor.perez@e-evolution.com

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_Locator

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_IsActive, COLUMNNAME_IsDefault, COLUMNNAME_M_Locator_ID, COLUMNNAME_M_Locator_UU, COLUMNNAME_M_LocatorType_ID, COLUMNNAME_M_Warehouse_ID, COLUMNNAME_PriorityNo, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, COLUMNNAME_Value, COLUMNNAME_X, COLUMNNAME_Y, COLUMNNAME_Z, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MLocator(Properties ctx, int M_Locator_ID, String trxName)	Standard Locator Constructor
MLocator(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MLocator(Properties ctx, MLocator copy)
MLocator(Properties ctx, MLocator copy, String trxName)
MLocator(MLocator copy)
MLocator(MWarehouse warehouse, String Value)	New Locator Constructor with XYZ=000

Method Summary

Modifier and Type	Method	Description
static MLocator	get(int M_Locator_ID)	Get Locator from Cache (immutable)
static MLocator	get(Properties ctx, int M_Locator_ID)	Get Locator from Cache (immutable)
static MLocator	get(Properties ctx, int M_Locator_ID, String trxName)	Get Locator from Cache (immutable)
static MLocator	get(Properties ctx, int M_Warehouse_ID, String Value, String X, String Y, String Z)
static MLocator	get(Properties ctx, int M_Warehouse_ID, String Value, String X, String Y, String Z, int M_LocatorType_ID)	Get the Locator with the combination or create new one (when user has permission)
static MLocator	getCopy(Properties ctx, int M_Locator_ID, String trxName)	Get updateable copy of MLocator from cache
static MLocator	getDefault(Properties ctx, int M_Locator_ID)	Get oldest Default Locator of warehouse with locator
static MLocator	getDefault(MWarehouse warehouse)	FR [ 1966333 ] Get oldest Default Locator of warehouse with locator
String	getWarehouseName()	Get Warehouse Name
boolean	isCanStoreProduct(int M_Product_ID)	Can Locator Store Product
MLocator	markImmutable()	mark PO as immutable
void	setXYZ(String X, String Y, String Z)	Set Location
String	toString()	Get String Representation

Methods inherited from class org.compiere.model.X_M_Locator

get_AccessLevel, getKeyNamePair, getM_Locator_ID, getM_Locator_UU, getM_LocatorType, getM_LocatorType_ID, getM_Warehouse, getM_Warehouse_ID, getPriorityNo, getValue, getX, getY, getZ, initPO, isDefault, setIsDefault, setM_Locator_ID, setM_Locator_UU, setM_LocatorType_ID, setM_Warehouse_ID, setPriorityNo, setValue, setX, setY, setZ

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, beforeSave, 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_Locator

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

MLocator

public MLocator(Properties ctx,
                int M_Locator_ID,
                String trxName)

Standard Locator Constructor

Parameters:

ctx - Context

M_Locator_ID - id

trxName - transaction

MLocator

public MLocator(MWarehouse warehouse,
                String Value)

New Locator Constructor with XYZ=000

Parameters:

warehouse - parent

Value - value

MLocator

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MLocator

public MLocator(MLocator copy)

Parameters:

copy -

MLocator

public MLocator(Properties ctx,
                MLocator copy)

Parameters:

ctx -

copy -

MLocator

public MLocator(Properties ctx,
                MLocator copy,
                String trxName)

Parameters:

ctx -

copy -

trxName -

Method Detail

getDefault

public static MLocator getDefault(Properties ctx,
                                  int M_Locator_ID)

Get oldest Default Locator of warehouse with locator

Parameters:

ctx - context

M_Locator_ID - locator

Returns:

locator or null

getDefault

public static MLocator getDefault(MWarehouse warehouse)

FR [ 1966333 ] Get oldest Default Locator of warehouse with locator

Parameters:

warehouse -

Returns:

locator or null

get

public static MLocator get(Properties ctx,
                           int M_Warehouse_ID,
                           String Value,
                           String X,
                           String Y,
                           String Z)

get

public static MLocator get(Properties ctx,
                           int M_Warehouse_ID,
                           String Value,
                           String X,
                           String Y,
                           String Z,
                           int M_LocatorType_ID)

Get the Locator with the combination or create new one (when user has permission)

Parameters:

ctx - Context

M_Warehouse_ID - warehouse

Value - value

X - x

Y - y

Z - z

Returns:

locator (or null when no insert permission on MLocator)

get

public static MLocator get(int M_Locator_ID)

Get Locator from Cache (immutable)

Parameters:

M_Locator_ID - id

Returns:

MLocator

get

public static MLocator get(Properties ctx,
                           int M_Locator_ID)

Get Locator from Cache (immutable)

Parameters:

ctx - context

M_Locator_ID - id

Returns:

MLocator

get

public static MLocator get(Properties ctx,
                           int M_Locator_ID,
                           String trxName)

Get Locator from Cache (immutable)

Parameters:

ctx - context

M_Locator_ID - id

trxName -

Returns:

MLocator

getCopy

public static MLocator getCopy(Properties ctx,
                               int M_Locator_ID,
                               String trxName)

Get updateable copy of MLocator from cache

Parameters:

ctx -

M_Locator_ID -

trxName -

Returns:

MLocator

toString

public String toString()

Get String Representation

Overrides:

toString in class X_M_Locator

Returns:

Value

setXYZ

public void setXYZ(String X,
                   String Y,
                   String Z)

Set Location

Parameters:

X - x

Y - y

Z - z

getWarehouseName

public String getWarehouseName()

Get Warehouse Name

Returns:

name

isCanStoreProduct

public boolean isCanStoreProduct(int M_Product_ID)

Can Locator Store Product

Parameters:

M_Product_ID - id

Returns:

true if can be stored

markImmutable

public MLocator markImmutable()

Description copied from interface: ImmutablePOSupport

mark PO as immutable

Specified by:

markImmutable in interface ImmutablePOSupport

Returns:

PO