org.compiere.model
Class MOrderLine

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_C_OrderLine
          org.compiere.model.MOrderLine

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, Evaluatee

public class MOrderLine
extends X_C_OrderLine

Order Line Model. MOrderLine ol = new MOrderLine(m_order); ol.setM_Product_ID(wbl.getM_Product_ID()); ol.setQtyOrdered(wbl.getQuantity()); ol.setPrice(); ol.setPriceActual(wbl.getPrice()); ol.setTax(); ol.save();

Version:

$Id: MOrderLine.java,v 1.6 2006/10/02 05:18:39 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_C_OrderLine

accessLevel, AD_ORGTRX_ID_AD_Reference_ID, M_WAREHOUSE_ID_AD_Reference_ID, Model, ORIG_INOUTLINE_ID_AD_Reference_ID, ORIG_ORDERLINE_ID_AD_Reference_ID, REF_ORDERLINE_ID_AD_Reference_ID, Table_ID, Table_Name, updatedMS, USER1_ID_AD_Reference_ID, USER2_ID_AD_Reference_ID

Fields inherited from class org.compiere.framework.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, log, p_changeVO, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Constructor Summary

MOrderLine(Ctx ctx, int C_OrderLine_ID, String trxName)
Default Constructor

MOrderLine(Ctx ctx, ResultSet rs, String trxName)
Load Constructor

MOrderLine(MOrder order)
Parent Constructor.

Method Summary

void	addDescription(String description) Add to Description
protected boolean	afterDelete(boolean success) After Delete
protected boolean	afterSave(boolean newRecord, boolean success) After Save
protected boolean	beforeDelete() Before Delete
protected boolean	beforeSave(boolean newRecord) Before Save
boolean	canChangeWarehouse() Can Change Warehouse
void	checkPrice()
int	getAD_OrgTrx_ID() Get AD_OrgTrx_ID
int	getC_Activity_ID() Get C_Activity_ID
int	getC_Campaign_ID() Get C_Campaign_ID
int	getC_Project_ID() Get C_Project_ID
String	getDescriptionText() Get Description Text.
String	getName() Get Name
static BigDecimal	getNotReserved(Ctx ctx, int M_Warehouse_ID, int M_Product_ID, int M_AttributeSetInstance_ID, int excludeC_OrderLine_ID) Get Order Unreserved Qty
MOrder	getParent() Get Parent
int	getPrecision() Get Currency Precision from Currency
MProduct	getProduct() Get Product
int	getUser1_ID() Get User2_ID
int	getUser2_ID() Get User2_ID
boolean	isTaxIncluded() Is Tax Included in Amount
void	setC_BPartner_Location_ID(String oldC_BPartner_Location_ID, String newC_BPartner_Location_ID, int windowNo) Set Partner Location - Callout
void	setC_Charge_ID(int C_Charge_ID) Set C_Charge_ID
void	setC_Charge_ID(String oldC_Charge_ID, String newC_Charge_ID, int windowNo) Set Charge - Callout
void	setC_UOM_ID(String oldC_UOM_ID, String newC_UOM_ID, int windowNo) Set UOM - Callout
void	setDiscount() Set Discount
void	setDiscount(String oldDiscount, String newDiscount, int windowNo) Set Discount - Callout
void	setHeaderInfo(MOrder order) Set Header Info
void	setLineNetAmt() Calculate Extended Amt.
void	setM_AttributeSetInstance_ID(int M_AttributeSetInstance_ID) Set M_AttributeSetInstance_ID
void	setM_AttributeSetInstance_ID(String oldM_AttributeSetInstance_ID, String newM_AttributeSetInstance_ID, int windowNo) Set AttributeSet Instance - Callout
void	setM_Product_ID(int M_Product_ID, boolean setUOM) Set M_Product_ID
void	setM_Product_ID(int M_Product_ID, int C_UOM_ID) Set Product and UOM
void	setM_Product_ID(String oldM_Product_ID, String newM_Product_ID, int windowNo) Set Product - Callout
void	setM_Warehouse_ID(int M_Warehouse_ID) Set Warehouse
void	setOrder(MOrder order) Set Defaults from Order.
void	setOrig_InOutLine_ID(String oldOrig_InOutLine_ID, String newOrig_InOutLine_ID, int windowNo) Set Original Shipment Line - Callout
void	setOrig_OrderLine_ID(String oldOrig_OrderLine_ID, String newOrig_OrderLine_ID, int windowNo) Set Original Order Line - Callout
void	setOrigInOutLine(MInOutLine Orig_InOutLine) Set Original Shipment Line for RMA SOTrx should be set.
void	setOrigOrderLine(MOrderLine origOrderLine) Set Original OrderLine for RMA SOTrx should be set.
void	setPrice() Set Price for Product and PriceList.
void	setPrice(BigDecimal PriceActual) Set Price Entered/Actual.
void	setPrice(int M_PriceList_ID) Set Price for Product and PriceList
void	setPriceActual(String oldPriceActual, String newPriceActual, int windowNo) Set PriceActual - Callout
void	setPriceEntered(String oldPriceEntered, String newPriceEntered, int windowNo) Set PriceEntered - Callout
void	setPriceList(String oldPriceList, String newPriceList, int windowNo) Set PriceList - Callout
void	setProduct(MProduct product) Set Product
void	setQty(BigDecimal Qty) Set Qty Entered/Ordered.
void	setQtyEntered(BigDecimal QtyEntered) Set Qty Entered - enforce entered UOM
void	setQtyEntered(String oldQtyEntered, String newQtyEntered, int windowNo) Set QtyEntered - Callout
void	setQtyOrdered(BigDecimal QtyOrdered) Set Qty Ordered - enforce Product UOM
void	setQtyOrdered(String oldQtyOrdered, String newQtyOrdered, int windowNo) Set QtyOrdered - Callout
void	setS_ResourceAssignment_ID(String oldS_ResourceAssignment_ID, String newS_ResourceAssignment_ID, int windowNo) Set Resource Assignment - Callout
boolean	setTax() Set Tax
String	toString() String Representation

Methods inherited from class org.compiere.model.X_C_OrderLine

get_AccessLevel, getC_BPartner_ID, getC_BPartner_Location_ID, getC_Charge_ID, getC_Currency_ID, getC_Order_ID, getC_OrderLine_ID, getC_ProjectPhase_ID, getC_ProjectTask_ID, getC_Tax_ID, getC_UOM_ID, getDateDelivered, getDateInvoiced, getDateOrdered, getDatePromised, getDescription, getDiscount, getFreightAmt, getKeyNamePair, getLine, getLineNetAmt, getM_AttributeSetInstance_ID, getM_Product_ID, getM_Shipper_ID, getM_Warehouse_ID, getOrig_InOutLine_ID, getOrig_OrderLine_ID, getPriceActual, getPriceCost, getPriceEntered, getPriceLimit, getPriceList, getQtyAllocated, getQtyDedicated, getQtyDelivered, getQtyEntered, getQtyInvoiced, getQtyLostSales, getQtyOrdered, getQtyReserved, getQtyReturned, getRef_OrderLine_ID, getRRAmt, getRRStartDate, getS_ResourceAssignment_ID, initPO, isDescription, isProcessed, setAD_OrgTrx_ID, setC_Activity_ID, setC_BPartner_ID, setC_BPartner_Location_ID, setC_Campaign_ID, setC_Currency_ID, setC_Order_ID, setC_OrderLine_ID, setC_Project_ID, setC_ProjectPhase_ID, setC_ProjectTask_ID, setC_Tax_ID, setC_UOM_ID, setDateDelivered, setDateInvoiced, setDateOrdered, setDatePromised, setDescription, setDiscount, setFreightAmt, setIsDescription, setLine, setLineNetAmt, setM_Product_ID, setM_Shipper_ID, setOrig_InOutLine_ID, setOrig_OrderLine_ID, setPriceActual, setPriceCost, setPriceEntered, setPriceLimit, setPriceList, setProcessed, setQtyAllocated, setQtyDedicated, setQtyDelivered, setQtyInvoiced, setQtyLostSales, setQtyReserved, setQtyReturned, setRef_OrderLine_ID, setRRAmt, setRRStartDate, setS_ResourceAssignment_ID, setUser1_ID, setUser2_ID

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, compare, convertToBigDecimal, convertToBoolean, convertToInt, convertToTimestamp, copy, copyValues, copyValues, createAttachment, delete_Accounting, delete, delete, dump, dump, equals, get_ChangeVO, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_EntityType, get_HashMap, get_ID, get_IDOld, get_Info, get_KeyColumns, get_Logger, get_Table_ID, get_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_ValuesAsString, get_WhereClause, get_xmlDocument, get_xmlString, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getVO, hashCode, insert_Accounting, is_Changed, is_KeyColumn, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveNew_getID, saveNewInsertSQL, saveNewSpecial, saveUpdate, set_ChangeVO, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueString, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setContext, setCtx, setDocWorkflowMgr, setIsActive, setStandardDefaults, setUpdateable, setUpdatedBy, toStringX, unlock, update

Methods inherited from class java.lang.Object

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

Constructor Detail

MOrderLine

public MOrderLine(Ctx ctx,
                  int C_OrderLine_ID,
                  String trxName)

Default Constructor

Parameters:

ctx - context

C_OrderLine_ID - order line to load

trxName - trx name

MOrderLine

public MOrderLine(MOrder order)

Parent Constructor. ol.setM_Product_ID(wbl.getM_Product_ID()); ol.setQtyOrdered(wbl.getQuantity()); ol.setPrice(); ol.setPriceActual(wbl.getPrice()); ol.setTax(); ol.save();

Parameters:

order - parent order

MOrderLine

public MOrderLine(Ctx ctx,
                  ResultSet rs,
                  String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set record

trxName - transaction

Method Detail

getNotReserved

public static BigDecimal getNotReserved(Ctx ctx,
                                        int M_Warehouse_ID,
                                        int M_Product_ID,
                                        int M_AttributeSetInstance_ID,
                                        int excludeC_OrderLine_ID)

Get Order Unreserved Qty

Parameters:

ctx - context

M_Warehouse_ID - wh

M_Product_ID - product

M_AttributeSetInstance_ID - asi

excludeC_OrderLine_ID - exclude C_OrderLine_ID

Returns:

Unreserved Qty

setOrder

public void setOrder(MOrder order)

Set Defaults from Order. Does not set Parent !!

Parameters:

order - order

setHeaderInfo

public void setHeaderInfo(MOrder order)

Set Header Info

Parameters:

order - order

getParent

public MOrder getParent()

Get Parent

Returns:

parent

setPrice

public void setPrice(BigDecimal PriceActual)

Set Price Entered/Actual. Use this Method if the Line UOM is the Product UOM

Parameters:

PriceActual - price

setPrice

public void setPrice()

Set Price for Product and PriceList. Use only if newly created. Uses standard price list of not set by order constructor

setPrice

public void setPrice(int M_PriceList_ID)

Set Price for Product and PriceList

Parameters:

M_PriceList_ID - price list

checkPrice

public void checkPrice()

setTax

public boolean setTax()

Set Tax

Returns:

true if tax is set

setLineNetAmt

public void setLineNetAmt()

Calculate Extended Amt. May or may not include tax

getPrecision

public int getPrecision()

Get Currency Precision from Currency

Returns:

precision

setProduct

public void setProduct(MProduct product)

Set Product

Parameters:

product - product

setM_Product_ID

public void setM_Product_ID(int M_Product_ID,
                            boolean setUOM)

Set M_Product_ID

Parameters:

M_Product_ID - product

setUOM - set also UOM

setM_Product_ID

public void setM_Product_ID(int M_Product_ID,
                            int C_UOM_ID)

Set Product and UOM

Parameters:

M_Product_ID - product

C_UOM_ID - uom

setM_Product_ID

@UICallout
public void setM_Product_ID(String oldM_Product_ID,
                                      String newM_Product_ID,
                                      int windowNo)
                     throws Exception

Set Product - Callout

Parameters:

oldM_Product_ID - old value

newM_Product_ID - new value

windowNo - window

Throws:

Exception

getProduct

public MProduct getProduct()

Get Product

Returns:

product or null

setM_AttributeSetInstance_ID

public void setM_AttributeSetInstance_ID(int M_AttributeSetInstance_ID)

Set M_AttributeSetInstance_ID

Overrides:

setM_AttributeSetInstance_ID in class X_C_OrderLine

Parameters:

M_AttributeSetInstance_ID - id

setM_Warehouse_ID

public void setM_Warehouse_ID(int M_Warehouse_ID)

Set Warehouse

Overrides:

setM_Warehouse_ID in class X_C_OrderLine

Parameters:

M_Warehouse_ID - warehouse

setC_BPartner_Location_ID

@UICallout
public void setC_BPartner_Location_ID(String oldC_BPartner_Location_ID,
                                                String newC_BPartner_Location_ID,
                                                int windowNo)
                               throws Exception

Set Partner Location - Callout

Parameters:

oldC_BPartner_Location_ID - old value

newC_BPartner_Location_ID - new value

windowNo - window

Throws:

Exception

setC_UOM_ID

@UICallout
public void setC_UOM_ID(String oldC_UOM_ID,
                                  String newC_UOM_ID,
                                  int windowNo)
                 throws Exception

Set UOM - Callout

Parameters:

oldC_UOM_ID - old value

newC_UOM_ID - new value

windowNo - window

Throws:

Exception

setM_AttributeSetInstance_ID

@UICallout
public void setM_AttributeSetInstance_ID(String oldM_AttributeSetInstance_ID,
                                                   String newM_AttributeSetInstance_ID,
                                                   int windowNo)
                                  throws Exception

Set AttributeSet Instance - Callout

Parameters:

oldM_AttributeSetInstance_ID - old value

newM_AttributeSetInstance_ID - new value

windowNo - window

Throws:

Exception

setDiscount

@UICallout
public void setDiscount(String oldDiscount,
                                  String newDiscount,
                                  int windowNo)
                 throws Exception

Set Discount - Callout

Parameters:

oldDiscount - old value

newDiscount - new value

windowNo - window

Throws:

Exception

setPriceActual

@UICallout
public void setPriceActual(String oldPriceActual,
                                     String newPriceActual,
                                     int windowNo)
                    throws Exception

Set PriceActual - Callout

Parameters:

oldPriceActual - old value

newPriceActual - new value

windowNo - window

Throws:

Exception

setPriceEntered

@UICallout
public void setPriceEntered(String oldPriceEntered,
                                      String newPriceEntered,
                                      int windowNo)
                     throws Exception

Set PriceEntered - Callout

Parameters:

oldPriceEntered - old value

newPriceEntered - new value

windowNo - window

Throws:

Exception

setPriceList

@UICallout
public void setPriceList(String oldPriceList,
                                   String newPriceList,
                                   int windowNo)
                  throws Exception

Set PriceList - Callout

Parameters:

oldPriceList - old value

newPriceList - new value

windowNo - window

Throws:

Exception

setQtyEntered

@UICallout
public void setQtyEntered(String oldQtyEntered,
                                    String newQtyEntered,
                                    int windowNo)
                   throws Exception

Set QtyEntered - Callout

Parameters:

oldQtyEntered - old value

newQtyEntered - new value

windowNo - window

Throws:

Exception

setQtyOrdered

@UICallout
public void setQtyOrdered(String oldQtyOrdered,
                                    String newQtyOrdered,
                                    int windowNo)
                   throws Exception

Set QtyOrdered - Callout

Parameters:

oldQtyOrdered - old value

newQtyOrdered - new value

windowNo - window

Throws:

Exception

setS_ResourceAssignment_ID

@UICallout
public void setS_ResourceAssignment_ID(String oldS_ResourceAssignment_ID,
                                                 String newS_ResourceAssignment_ID,
                                                 int windowNo)
                                throws Exception

Set Resource Assignment - Callout

Parameters:

oldS_ResourceAssignment_ID - old value

newS_ResourceAssignment_ID - new value

windowNo - window

Throws:

Exception

canChangeWarehouse

public boolean canChangeWarehouse()

Can Change Warehouse

Returns:

true if warehouse can be changed

getC_Project_ID

public int getC_Project_ID()

Get C_Project_ID

Overrides:

getC_Project_ID in class X_C_OrderLine

Returns:

project

getC_Activity_ID

public int getC_Activity_ID()

Get C_Activity_ID

Overrides:

getC_Activity_ID in class X_C_OrderLine

Returns:

Activity

getC_Campaign_ID

public int getC_Campaign_ID()

Get C_Campaign_ID

Overrides:

getC_Campaign_ID in class X_C_OrderLine

Returns:

Campaign

getUser1_ID

public int getUser1_ID()

Get User2_ID

Overrides:

getUser1_ID in class X_C_OrderLine

Returns:

User2

getUser2_ID

public int getUser2_ID()

Get User2_ID

Overrides:

getUser2_ID in class X_C_OrderLine

Returns:

User2

getAD_OrgTrx_ID

public int getAD_OrgTrx_ID()

Get AD_OrgTrx_ID

Overrides:

getAD_OrgTrx_ID in class X_C_OrderLine

Returns:

trx org

toString

public String toString()

String Representation

Overrides:

toString in class X_C_OrderLine

Returns:

info

addDescription

public void addDescription(String description)

Add to Description

Parameters:

description - text

getDescriptionText

public String getDescriptionText()

Get Description Text. For jsp access (vs. isDescription)

Returns:

description

getName

public String getName()

Get Name

Returns:

get the name of the line (from Product)

setC_Charge_ID

public void setC_Charge_ID(int C_Charge_ID)

Set C_Charge_ID

Overrides:

setC_Charge_ID in class X_C_OrderLine

Parameters:

C_Charge_ID - charge

setC_Charge_ID

@UICallout
public void setC_Charge_ID(String oldC_Charge_ID,
                                     String newC_Charge_ID,
                                     int windowNo)
                    throws Exception

Set Charge - Callout

Parameters:

oldC_Charge_ID - old value

newC_Charge_ID - new value

windowNo - window

Throws:

Exception

setDiscount

public void setDiscount()

Set Discount

isTaxIncluded

public boolean isTaxIncluded()

Is Tax Included in Amount

Returns:

true if tax calculated

setQty

public void setQty(BigDecimal Qty)

Set Qty Entered/Ordered. Use this Method if the Line UOM is the Product UOM

Parameters:

Qty - QtyOrdered/Entered

setQtyEntered

public void setQtyEntered(BigDecimal QtyEntered)

Set Qty Entered - enforce entered UOM

Overrides:

setQtyEntered in class X_C_OrderLine

Parameters:

QtyEntered -

setQtyOrdered

public void setQtyOrdered(BigDecimal QtyOrdered)

Set Qty Ordered - enforce Product UOM

Overrides:

setQtyOrdered in class X_C_OrderLine

Parameters:

QtyOrdered -

setOrigOrderLine

public void setOrigOrderLine(MOrderLine origOrderLine)

Set Original OrderLine for RMA SOTrx should be set.

Parameters:

origIOLine - MInOutLine

setOrig_OrderLine_ID

@UICallout
public void setOrig_OrderLine_ID(String oldOrig_OrderLine_ID,
                                           String newOrig_OrderLine_ID,
                                           int windowNo)
                          throws Exception

Set Original Order Line - Callout

Parameters:

oldOrig_InOutLine_ID - old Orig Order

newOrig_InOutLine_ID - new Orig Order

windowNo - window no

Throws:

Exception

setOrigInOutLine

public void setOrigInOutLine(MInOutLine Orig_InOutLine)

Set Original Shipment Line for RMA SOTrx should be set.

Parameters:

origIOLine - MInOutLine

setOrig_InOutLine_ID

@UICallout
public void setOrig_InOutLine_ID(String oldOrig_InOutLine_ID,
                                           String newOrig_InOutLine_ID,
                                           int windowNo)
                          throws Exception

Set Original Shipment Line - Callout

Parameters:

oldOrig_InOutLine_ID - old Orig Order

newOrig_InOutLine_ID - new Orig Order

windowNo - window no

Throws:

Exception

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save

Overrides:

beforeSave in class PO

Parameters:

newRecord -

Returns:

true if it can be saved

beforeDelete

protected boolean beforeDelete()

Before Delete

Overrides:

beforeDelete in class PO

Returns:

true if it can be deleted

afterSave

protected boolean afterSave(boolean newRecord,
                            boolean success)

After Save

Overrides:

afterSave in class PO

Parameters:

newRecord - new

success - success

Returns:

saved

afterDelete

protected boolean afterDelete(boolean success)

After Delete

Overrides:

afterDelete in class PO

Parameters:

success - success

Returns:

deleted