org.compiere.model
Class MInvoiceLine

java.lang.Object
  org.compiere.model.PO
      org.compiere.model.X_C_InvoiceLine
          org.compiere.model.MInvoiceLine

All Implemented Interfaces:

Serializable, Comparator, I_C_InvoiceLine, I_Persistent, Evaluatee

public class MInvoiceLine
extends X_C_InvoiceLine

Invoice Line Model

Version:

$Id: MInvoiceLine.java,v 1.5 2006/07/30 00:51:03 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_C_InvoiceLine

A_CAPVSEXP_AD_Reference_ID, A_CAPVSEXP_Capital, A_CAPVSEXP_Expense, AD_ORGTRX_ID_AD_Reference_ID, USER1_ID_AD_Reference_ID, USER2_ID_AD_Reference_ID

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, log, p_ctx, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_C_InvoiceLine

accessLevel, COLUMNNAME_A_Asset_Group_ID, COLUMNNAME_A_Asset_ID, COLUMNNAME_A_CapvsExp, COLUMNNAME_A_CreateAsset, COLUMNNAME_A_Processed, COLUMNNAME_AD_OrgTrx_ID, COLUMNNAME_C_Activity_ID, COLUMNNAME_C_Campaign_ID, COLUMNNAME_C_Charge_ID, COLUMNNAME_C_Invoice_ID, COLUMNNAME_C_InvoiceLine_ID, COLUMNNAME_C_OrderLine_ID, COLUMNNAME_C_Project_ID, COLUMNNAME_C_ProjectPhase_ID, COLUMNNAME_C_ProjectTask_ID, COLUMNNAME_C_Tax_ID, COLUMNNAME_C_UOM_ID, COLUMNNAME_Description, COLUMNNAME_IsDescription, COLUMNNAME_IsPrinted, COLUMNNAME_Line, COLUMNNAME_LineNetAmt, COLUMNNAME_LineTotalAmt, COLUMNNAME_M_AttributeSetInstance_ID, COLUMNNAME_M_InOutLine_ID, COLUMNNAME_M_Product_ID, COLUMNNAME_M_RMALine_ID, COLUMNNAME_PriceActual, COLUMNNAME_PriceEntered, COLUMNNAME_PriceLimit, COLUMNNAME_PriceList, COLUMNNAME_Processed, COLUMNNAME_QtyEntered, COLUMNNAME_QtyInvoiced, COLUMNNAME_Ref_InvoiceLine_ID, COLUMNNAME_RRAmt, COLUMNNAME_RRStartDate, COLUMNNAME_S_ResourceAssignment_ID, COLUMNNAME_TaxAmt, COLUMNNAME_User1_ID, COLUMNNAME_User2_ID, Model, Table_ID, Table_Name

Constructor Summary

MInvoiceLine(MInvoice invoice)
Parent Constructor

MInvoiceLine(Properties ctx, int C_InvoiceLine_ID, String trxName)
Invoice Line Constructor

MInvoiceLine(Properties ctx, ResultSet rs, String trxName)
Load 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
String	allocateLandedCosts() Allocate Landed Costs
protected boolean	beforeSave(boolean newRecord) Before Save
int	copyLandedCostFrom(MInvoiceLine otherInvoiceLine) Copy LandedCost From other InvoiceLine.
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.
MLandedCost[]	getLandedCost(String whereClause) Get LandedCost of InvoiceLine
String	getName() Get (Product/Charge) Name
static MInvoiceLine	getOfInOutLine(MInOutLine sLine) Get Invoice Line referencing InOut Line
MInvoice	getParent() Get Parent
int	getPrecision() Get Currency Precision
MProduct	getProduct() Get Product
int	getUser1_ID() Get User2_ID
int	getUser2_ID() Get User2_ID
boolean	isTaxIncluded() Is Tax Included in Amount
void	setInvoice(MInvoice invoice) Set Defaults from Order.
void	setLineNetAmt() Calculate Extended Amt.
void	setM_AttributeSetInstance_ID(int M_AttributeSetInstance_ID) Set M_AttributeSetInstance_ID
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	setName(String tempName) Set Temporary (cached) Name
void	setOrderLine(MOrderLine oLine) Set values from Order Line.
void	setPrice() Set Price for Product and PriceList.
void	setPrice(BigDecimal PriceActual) Set Price Entered/Actual.
void	setPrice(int M_PriceList_ID, int C_BPartner_ID) Set Price for Product and PriceList
void	setPriceActual(BigDecimal PriceActual) Set Price Actual.
void	setProduct(MProduct product) Set Product
void	setQty(BigDecimal Qty) Set Qty Invoiced
void	setQty(int Qty) Set Qty Invoiced/Entered.
void	setQtyEntered(BigDecimal QtyEntered) Set Qty Entered - enforce entered UOM
void	setQtyInvoiced(BigDecimal QtyInvoiced) Set Qty Invoiced - enforce Product UOM
void	setRMALine(MRMALine rmaLine)
void	setShipLine(MInOutLine sLine) Set values from Shipment Line.
boolean	setTax() Set Tax - requires Warehouse
void	setTaxAmt() Calculare Tax Amt.
String	toString() String Representation

Methods inherited from class org.compiere.model.X_C_InvoiceLine

get_AccessLevel, getA_Asset_Group_ID, getA_Asset_Group, getA_Asset_ID, getA_Asset, getA_CapvsExp, getC_Activity, getC_Campaign, getC_Charge_ID, getC_Charge, getC_Invoice_ID, getC_Invoice, getC_InvoiceLine_ID, getC_OrderLine_ID, getC_OrderLine, getC_Project, getC_ProjectPhase_ID, getC_ProjectPhase, getC_ProjectTask_ID, getC_ProjectTask, getC_Tax_ID, getC_Tax, getC_UOM_ID, getC_UOM, getDescription, getKeyNamePair, getLine, getLineNetAmt, getLineTotalAmt, getM_AttributeSetInstance_ID, getM_InOutLine_ID, getM_InOutLine, getM_Product_ID, getM_Product, getM_RMALine_ID, getM_RMALine, getPriceActual, getPriceEntered, getPriceLimit, getPriceList, getQtyEntered, getQtyInvoiced, getRef_InvoiceLine_ID, getRRAmt, getRRStartDate, getS_ResourceAssignment_ID, getTaxAmt, initPO, isA_CreateAsset, isA_Processed, isDescription, isPrinted, isProcessed, setA_Asset_Group_ID, setA_Asset_ID, setA_CapvsExp, setA_CreateAsset, setA_Processed, setAD_OrgTrx_ID, setC_Activity_ID, setC_Campaign_ID, setC_Charge_ID, setC_Invoice_ID, setC_InvoiceLine_ID, setC_OrderLine_ID, setC_Project_ID, setC_ProjectPhase_ID, setC_ProjectTask_ID, setC_Tax_ID, setC_UOM_ID, setDescription, setIsDescription, setIsPrinted, setLine, setLineNetAmt, setLineTotalAmt, setM_InOutLine_ID, setM_Product_ID, setM_RMALine_ID, setPriceEntered, setPriceLimit, setPriceList, setProcessed, setRef_InvoiceLine_ID, setRRAmt, setRRStartDate, setS_ResourceAssignment_ID, setTaxAmt, setUser1_ID, setUser2_ID

Methods inherited from class org.compiere.model.PO

beforeDelete, compare, copyValues, copyValues, createAttachment, delete_Accounting, delete_Tree, delete, delete, deleteEx, deleteEx, dump, dump, equals, 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_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveEx, saveEx, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setDoc, setDocWorkflowMgr, setIsActive, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, unlock

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.compiere.model.I_Persistent

save

Constructor Detail

MInvoiceLine

public MInvoiceLine(Properties ctx,
                    int C_InvoiceLine_ID,
                    String trxName)

Invoice Line Constructor

Parameters:

ctx - context

C_InvoiceLine_ID - invoice line or 0

trxName - transaction name

MInvoiceLine

public MInvoiceLine(MInvoice invoice)

Parent Constructor

Parameters:

invoice - parent

MInvoiceLine

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

Load Constructor

Parameters:

ctx - context

rs - result set record

trxName - transaction

Method Detail

getOfInOutLine

public static MInvoiceLine getOfInOutLine(MInOutLine sLine)

Get Invoice Line referencing InOut Line

Parameters:

sLine - shipment line

Returns:

(first) invoice line

setInvoice

public void setInvoice(MInvoice invoice)

Set Defaults from Order. Called also from copy lines from invoice Does not set Parent !!

Parameters:

invoice - invoice

getParent

public MInvoice getParent()

Get Parent

Returns:

parent

setOrderLine

public void setOrderLine(MOrderLine oLine)

Set values from Order Line. Does not set quantity!

Parameters:

oLine - line

setShipLine

public void setShipLine(MInOutLine sLine)

Set values from Shipment Line. Does not set quantity!

Parameters:

sLine - ship line

addDescription

public void addDescription(String description)

Add to Description

Parameters:

description - text

setM_AttributeSetInstance_ID

public void setM_AttributeSetInstance_ID(int M_AttributeSetInstance_ID)

Set M_AttributeSetInstance_ID

Specified by:

setM_AttributeSetInstance_ID in interface I_C_InvoiceLine

Overrides:

setM_AttributeSetInstance_ID in class X_C_InvoiceLine

Parameters:

M_AttributeSetInstance_ID - id

setPrice

public void setPrice()

Set Price for Product and PriceList. Uses standard SO price list of not set by invoice constructor

setPrice

public void setPrice(int M_PriceList_ID,
                     int C_BPartner_ID)

Set Price for Product and PriceList

Parameters:

M_PriceList_ID - price list

C_BPartner_ID - business partner

setPrice

public void setPrice(BigDecimal PriceActual)

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

Parameters:

PriceActual - price

setPriceActual

public void setPriceActual(BigDecimal PriceActual)

Set Price Actual. (actual price is not updateable)

Specified by:

setPriceActual in interface I_C_InvoiceLine

Overrides:

setPriceActual in class X_C_InvoiceLine

Parameters:

PriceActual - actual price

setTax

public boolean setTax()

Set Tax - requires Warehouse

Returns:

true if found

setTaxAmt

public void setTaxAmt()

Calculare Tax Amt. Assumes Line Net is calculated

setLineNetAmt

public void setLineNetAmt()

Calculate Extended Amt. May or may not include tax

setQty

public void setQty(int Qty)

Set Qty Invoiced/Entered.

Parameters:

Qty - Invoiced/Ordered

setQty

public void setQty(BigDecimal Qty)

Set Qty Invoiced

Parameters:

Qty - Invoiced/Entered

setQtyEntered

public void setQtyEntered(BigDecimal QtyEntered)

Set Qty Entered - enforce entered UOM

Specified by:

setQtyEntered in interface I_C_InvoiceLine

Overrides:

setQtyEntered in class X_C_InvoiceLine

Parameters:

QtyEntered -

setQtyInvoiced

public void setQtyInvoiced(BigDecimal QtyInvoiced)

Set Qty Invoiced - enforce Product UOM

Specified by:

setQtyInvoiced in interface I_C_InvoiceLine

Overrides:

setQtyInvoiced in class X_C_InvoiceLine

Parameters:

QtyInvoiced -

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 UOM from product

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

getProduct

public MProduct getProduct()

Get Product

Returns:

product or null

getC_Project_ID

public int getC_Project_ID()

Get C_Project_ID

Specified by:

getC_Project_ID in interface I_C_InvoiceLine

Overrides:

getC_Project_ID in class X_C_InvoiceLine

Returns:

project

getC_Activity_ID

public int getC_Activity_ID()

Get C_Activity_ID

Specified by:

getC_Activity_ID in interface I_C_InvoiceLine

Overrides:

getC_Activity_ID in class X_C_InvoiceLine

Returns:

Activity

getC_Campaign_ID

public int getC_Campaign_ID()

Get C_Campaign_ID

Specified by:

getC_Campaign_ID in interface I_C_InvoiceLine

Overrides:

getC_Campaign_ID in class X_C_InvoiceLine

Returns:

Campaign

getUser1_ID

public int getUser1_ID()

Get User2_ID

Specified by:

getUser1_ID in interface I_C_InvoiceLine

Overrides:

getUser1_ID in class X_C_InvoiceLine

Returns:

User2

getUser2_ID

public int getUser2_ID()

Get User2_ID

Specified by:

getUser2_ID in interface I_C_InvoiceLine

Overrides:

getUser2_ID in class X_C_InvoiceLine

Returns:

User2

getAD_OrgTrx_ID

public int getAD_OrgTrx_ID()

Get AD_OrgTrx_ID

Specified by:

getAD_OrgTrx_ID in interface I_C_InvoiceLine

Overrides:

getAD_OrgTrx_ID in class X_C_InvoiceLine

Returns:

trx org

toString

public String toString()

String Representation

Overrides:

toString in class X_C_InvoiceLine

Returns:

info

getName

public String getName()

Get (Product/Charge) Name

Returns:

name

setName

public void setName(String tempName)

Set Temporary (cached) Name

Parameters:

tempName - Cached Name

getDescriptionText

public String getDescriptionText()

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

Returns:

description

getPrecision

public int getPrecision()

Get Currency Precision

Returns:

precision

isTaxIncluded

public boolean isTaxIncluded()

Is Tax Included in Amount

Returns:

true if tax is included

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save

Overrides:

beforeSave in class PO

Parameters:

newRecord -

Returns:

true if save

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

allocateLandedCosts

public String allocateLandedCosts()

Allocate Landed Costs

Returns:

error message or ""

getLandedCost

public MLandedCost[] getLandedCost(String whereClause)

Get LandedCost of InvoiceLine

Parameters:

whereClause - starting with AND

Returns:

landedCost

copyLandedCostFrom

public int copyLandedCostFrom(MInvoiceLine otherInvoiceLine)

Copy LandedCost From other InvoiceLine.

Parameters:

otherInvoiceLine - invoiceline

Returns:

number of lines copied

setRMALine

public void setRMALine(MRMALine rmaLine)

Parameters:

rmaline -