Package org.compiere.model

Class MMovement

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_M_Movement

org.compiere.model.MMovement

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_M_Movement, I_Persistent, DocAction, Evaluatee

public class MMovement
extends X_M_Movement
implements DocAction

Inventory Movement Model

Version:

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

Author:

Jorg Janke, victor.perez@e-evolution.com, e-Evolution http://www.e-evolution.com

FR [ 1948157 ] Is necessary the reference for document reverse, Armen Rizal, Goodwill Consulting

BF [ 1745154 ] Cost in Reversing Material Related Docs, Teo Sarca, www.arhipac.ro

FR [ 2214883 ] Remove SQL code and Replace for Query

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected MMovementConfirm[]	m_confirms	Confirmations
protected boolean	m_justPrepared	Just Prepared Flag
protected MMovementLine[]	m_lines	Lines
protected String	m_processMsg	Process Message
protected boolean	m_reversal	Reversal Flag
static String	REVERSE_INDICATOR	Reversal Indicator

Fields inherited from class org.compiere.model.X_M_Movement

DELIVERYRULE_AD_Reference_ID, DELIVERYRULE_AfterPayment, DELIVERYRULE_Availability, DELIVERYRULE_CompleteLine, DELIVERYRULE_CompleteOrder, DELIVERYRULE_Force, DELIVERYRULE_Manual, DELIVERYVIARULE_AD_Reference_ID, DELIVERYVIARULE_Delivery, DELIVERYVIARULE_Pickup, DELIVERYVIARULE_Shipper, DOCACTION_AD_Reference_ID, DOCACTION_Approve, DOCACTION_Close, DOCACTION_Complete, DOCACTION_Invalidate, DOCACTION_None, DOCACTION_Post, DOCACTION_Prepare, DOCACTION_Re_Activate, DOCACTION_Reject, DOCACTION_Reverse_Accrual, DOCACTION_Reverse_Correct, DOCACTION_Unlock, DOCACTION_Void, DOCACTION_WaitComplete, DOCSTATUS_AD_Reference_ID, DOCSTATUS_Approved, DOCSTATUS_Closed, DOCSTATUS_Completed, DOCSTATUS_Drafted, DOCSTATUS_InProgress, DOCSTATUS_Invalid, DOCSTATUS_NotApproved, DOCSTATUS_Reversed, DOCSTATUS_Unknown, DOCSTATUS_Voided, DOCSTATUS_WaitingConfirmation, DOCSTATUS_WaitingPayment, FREIGHTCOSTRULE_AD_Reference_ID, FREIGHTCOSTRULE_Calculated, FREIGHTCOSTRULE_CustomerAccount, FREIGHTCOSTRULE_FixPrice, FREIGHTCOSTRULE_FreightIncluded, FREIGHTCOSTRULE_Line, PRIORITYRULE_AD_Reference_ID, PRIORITYRULE_High, PRIORITYRULE_Low, PRIORITYRULE_Medium, PRIORITYRULE_Minor, PRIORITYRULE_Urgent

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, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.process.DocAction

ACTION_Approve, ACTION_Close, ACTION_Complete, ACTION_Invalidate, ACTION_None, ACTION_Post, ACTION_Prepare, ACTION_ReActivate, ACTION_Reject, ACTION_Reverse_Accrual, ACTION_Reverse_Correct, ACTION_Unlock, ACTION_Void, ACTION_WaitComplete, AD_REFERENCE_ID, DOC_COLUMNNAME_AD_User_ID, DOC_COLUMNNAME_C_Currency_ID, DOC_COLUMNNAME_C_DocType_ID, DOC_COLUMNNAME_C_DocTypeTarget_ID, DOC_COLUMNNAME_DateAcct, DOC_COLUMNNAME_DateTrx, DOC_COLUMNNAME_Description, DOC_COLUMNNAME_DocAction, DOC_COLUMNNAME_DocStatus, DOC_COLUMNNAME_DocumentNo, DOC_COLUMNNAME_IsApproved, DOC_COLUMNNAME_Processed, DOC_COLUMNNAME_Processing, DOC_COLUMNNAME_SalesRep_ID, STATUS_Approved, STATUS_Closed, STATUS_Completed, STATUS_Drafted, STATUS_InProgress, STATUS_Invalid, STATUS_NotApproved, STATUS_Reversed, STATUS_Unknown, STATUS_Voided, STATUS_WaitingConfirmation, STATUS_WaitingPayment

Fields inherited from interface org.compiere.model.I_M_Movement

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_OrgTrx_ID, COLUMNNAME_AD_User_ID, COLUMNNAME_ApprovalAmt, COLUMNNAME_C_Activity_ID, COLUMNNAME_C_BPartner_ID, COLUMNNAME_C_BPartner_Location_ID, COLUMNNAME_C_Campaign_ID, COLUMNNAME_C_Charge_ID, COLUMNNAME_C_DocType_ID, COLUMNNAME_C_Project_ID, COLUMNNAME_ChargeAmt, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_CreateFrom, COLUMNNAME_DateReceived, COLUMNNAME_DD_Order_ID, COLUMNNAME_DeliveryRule, COLUMNNAME_DeliveryViaRule, COLUMNNAME_Description, COLUMNNAME_DocAction, COLUMNNAME_DocStatus, COLUMNNAME_DocumentNo, COLUMNNAME_FreightAmt, COLUMNNAME_FreightCostRule, COLUMNNAME_IsActive, COLUMNNAME_IsApproved, COLUMNNAME_IsInTransit, COLUMNNAME_M_Movement_ID, COLUMNNAME_M_Movement_UU, COLUMNNAME_M_Shipper_ID, COLUMNNAME_M_Warehouse_ID, COLUMNNAME_M_WarehouseTo_ID, COLUMNNAME_MovementDate, COLUMNNAME_POReference, COLUMNNAME_Posted, COLUMNNAME_PriorityRule, COLUMNNAME_Processed, COLUMNNAME_ProcessedOn, COLUMNNAME_Processing, COLUMNNAME_Reversal_ID, COLUMNNAME_SalesRep_ID, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, COLUMNNAME_User1_ID, COLUMNNAME_User2_ID, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MMovement(Properties ctx, int M_Movement_ID, String trxName)	Standard Constructor
MMovement(Properties ctx, String M_Movement_UU, String trxName)	UUID based Constructor
MMovement(Properties ctx, ResultSet rs, String trxName)	Load Constructor

Method Summary

Modifier and Type	Method	Description
void	addDescription(String description)	Add to Description
boolean	approveIt()	Approve Document
protected boolean	beforeSave(boolean newRecord)	Before Save
protected void	checkMaterialPolicy(MMovementLine line, BigDecimal qtyToDeliver)	Check Material Policy.
boolean	closeIt()	Close Document.
String	completeIt()	Complete Document
protected void	createConfirmation()	Create Movement Confirmation
File	createPDF()	Create PDF
File	createPDF(File file)	Create PDF file
int	getC_Currency_ID()	Get Document Currency
MMovementConfirm[]	getConfirmations(boolean requery)	Get Confirmations
int	getDoc_User_ID()	Get Document Owner (Responsible)
String	getDocumentInfo()	Get Document Info
MMovementLine[]	getLines(boolean requery)	Get Lines
String	getProcessMsg()	Get Process Message
String	getSummary()	Get Summary
boolean	invalidateIt()	Invalidate Document
boolean	isComplete()	Document Status is Complete or Closed
protected boolean	isReversal()	Is Reversal
boolean	pendingConfirmations()	Outstanding (not processed) movement Confirmations ?
String	prepareIt()	Prepare Document
boolean	processIt(String processAction)	Process document
boolean	reActivateIt()	Re-activate
boolean	rejectIt()	Reject Approval
protected MMovement	reverse(boolean accrual)	Reverse this movement document
boolean	reverseAccrualIt()	Reverse Accrual - use current date
boolean	reverseCorrectIt()	Reverse Correction
protected void	setDefiniteDocumentNo()	Set the definite document number after completed
void	setProcessed(boolean processed)	Set Processed.
protected void	setReversal(boolean reversal)	Set Reversal state (in memory flag)
boolean	unlockIt()	Unlock Document.
boolean	voidIt()	Void Document.

Methods inherited from class org.compiere.model.X_M_Movement

get_AccessLevel, getAD_OrgTrx_ID, getAD_User, getAD_User_ID, getApprovalAmt, getC_Activity, getC_Activity_ID, getC_BPartner, getC_BPartner_ID, getC_BPartner_Location, getC_BPartner_Location_ID, getC_Campaign, getC_Campaign_ID, getC_Charge, getC_Charge_ID, getC_DocType, getC_DocType_ID, getC_Project, getC_Project_ID, getChargeAmt, getCreateFrom, getDateReceived, getDD_Order, getDD_Order_ID, getDeliveryRule, getDeliveryViaRule, getDescription, getDocAction, getDocStatus, getDocumentNo, getFreightAmt, getFreightCostRule, getKeyNamePair, getM_Movement_ID, getM_Movement_UU, getM_Shipper, getM_Shipper_ID, getM_Warehouse, getM_Warehouse_ID, getM_WarehouseTo, getM_WarehouseTo_ID, getMovementDate, getPOReference, getPriorityRule, getProcessedOn, getReversal, getReversal_ID, getSalesRep, getSalesRep_ID, getUser1, getUser1_ID, getUser2, getUser2_ID, initPO, isApproved, isInTransit, isPosted, isProcessed, isProcessing, setAD_OrgTrx_ID, setAD_User_ID, setApprovalAmt, setC_Activity_ID, setC_BPartner_ID, setC_BPartner_Location_ID, setC_Campaign_ID, setC_Charge_ID, setC_DocType_ID, setC_Project_ID, setChargeAmt, setCreateFrom, setDateReceived, setDD_Order_ID, setDeliveryRule, setDeliveryViaRule, setDescription, setDocAction, setDocStatus, setDocumentNo, setFreightAmt, setFreightCostRule, setIsApproved, setIsInTransit, setM_Movement_ID, setM_Movement_UU, setM_Shipper_ID, setM_Warehouse_ID, setM_WarehouseTo_ID, setMovementDate, setPOReference, setPosted, setPriorityRule, setProcessedOn, setProcessing, setReversal_ID, setSalesRep_ID, setUser1_ID, setUser2_ID, toString

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, buildInsertSQL, 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_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, 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, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, 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, toInsertSQL, 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.process.DocAction

get_ID, get_Logger, get_Table_ID, get_TrxName, getAD_Client_ID, getAD_Org_ID, getApprovalAmt, getCtx, getDocAction, getDocStatus, getDocumentNo, save, saveEx, setDocStatus

Methods inherited from interface org.compiere.model.I_M_Movement

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

Field Details

m_lines

protected MMovementLine[] m_lines

Lines

m_confirms

protected MMovementConfirm[] m_confirms

Confirmations

REVERSE_INDICATOR

public static String REVERSE_INDICATOR

Reversal Indicator

m_processMsg

protected String m_processMsg

Process Message

m_justPrepared

protected boolean m_justPrepared

Just Prepared Flag

m_reversal

protected boolean m_reversal

Reversal Flag

Constructor Details

MMovement

public MMovement(Properties ctx,
 String M_Movement_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

M_Movement_UU - UUID key

trxName - Transaction

MMovement

public MMovement(Properties ctx,
 int M_Movement_ID,
 String trxName)

Standard Constructor

Parameters:

ctx - context

M_Movement_ID - id

trxName - transaction

MMovement

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

Method Details

getLines

public MMovementLine[] getLines(boolean requery)

Get Lines

Parameters:

requery - requery

Returns:

array of lines

getConfirmations

public MMovementConfirm[] getConfirmations(boolean requery)

Get Confirmations

Parameters:

requery - requery

Returns:

array of Confirmations

addDescription

public void addDescription(String description)

Add to Description

Parameters:

description - text

getDocumentInfo

public String getDocumentInfo()

Get Document Info

Specified by:

getDocumentInfo in interface DocAction

Returns:

document info (untranslated)

createPDF

public File createPDF()

Create PDF

Specified by:

createPDF in interface DocAction

Returns:

File or null

createPDF

public File createPDF(File file)

Create PDF file

Parameters:

file - output file

Returns:

not implemented, always return null

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save

Overrides:

beforeSave in class PO

Parameters:

newRecord - new

Returns:

true

setProcessed

public void setProcessed(boolean processed)

Set Processed. Propagate to Lines.

Specified by:

setProcessed in interface I_M_Movement

Overrides:

setProcessed in class X_M_Movement

Parameters:

processed - processed

processIt

public boolean processIt(String processAction)

Process document

Specified by:

processIt in interface DocAction

Parameters:

processAction - document action

Returns:

true if success

unlockIt

public boolean unlockIt()

Unlock Document.

Specified by:

unlockIt in interface DocAction

Returns:

true if success

invalidateIt

public boolean invalidateIt()

Invalidate Document

Specified by:

invalidateIt in interface DocAction

Returns:

true if success

prepareIt

public String prepareIt()

Prepare Document

Specified by:

prepareIt in interface DocAction

Returns:

new status (In Progress or Invalid)

createConfirmation

protected void createConfirmation()

Create Movement Confirmation

approveIt

public boolean approveIt()

Approve Document

Specified by:

approveIt in interface DocAction

Returns:

true if success

rejectIt

public boolean rejectIt()

Reject Approval

Specified by:

rejectIt in interface DocAction

Returns:

true if success

completeIt

public String completeIt()

Complete Document

Specified by:

completeIt in interface DocAction

Returns:

new status (Complete, In Progress, Invalid, Waiting ..)

pendingConfirmations

public boolean pendingConfirmations()

Outstanding (not processed) movement Confirmations ?

Returns:

true if there are pending Confirmations

setDefiniteDocumentNo

protected void setDefiniteDocumentNo()

Set the definite document number after completed

checkMaterialPolicy

protected void checkMaterialPolicy(MMovementLine line,
 BigDecimal qtyToDeliver)

Check Material Policy. Create MMovementLineMA records (if line M_AttributeSetInstance_ID is 0).

Parameters:

line -

qtyToDeliver -

voidIt

public boolean voidIt()

Void Document.

Specified by:

voidIt in interface DocAction

Returns:

true if success

closeIt

public boolean closeIt()

Close Document.

Specified by:

closeIt in interface DocAction

Returns:

true if success

reverseCorrectIt

public boolean reverseCorrectIt()

Reverse Correction

Specified by:

reverseCorrectIt in interface DocAction

Returns:

false

reverse

protected MMovement reverse(boolean accrual)

Reverse this movement document

Parameters:

accrual - true to use current date, false to use movement date of this document

Returns:

reversal movement document

reverseAccrualIt

public boolean reverseAccrualIt()

Reverse Accrual - use current date

Specified by:

reverseAccrualIt in interface DocAction

Returns:

false

reActivateIt

public boolean reActivateIt()

Re-activate

Specified by:

reActivateIt in interface DocAction

Returns:

false

getSummary

public String getSummary()

Get Summary

Specified by:

getSummary in interface DocAction

Returns:

Summary of Document

getProcessMsg

public String getProcessMsg()

Get Process Message

Specified by:

getProcessMsg in interface DocAction

Returns:

clear text error message

getDoc_User_ID

public int getDoc_User_ID()

Get Document Owner (Responsible)

Specified by:

getDoc_User_ID in interface DocAction

Returns:

AD_User_ID

getC_Currency_ID

public int getC_Currency_ID()

Get Document Currency

Specified by:

getC_Currency_ID in interface DocAction

Returns:

C_Currency_ID

setReversal

protected void setReversal(boolean reversal)

Set Reversal state (in memory flag)

Parameters:

reversal - reversal

isReversal

protected boolean isReversal()

Is Reversal

Returns:

reversal state (in memory flag)

isComplete

public boolean isComplete()

Document Status is Complete or Closed

Returns:

true if CO, CL or RE