Package org.compiere.model

Class 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 Detail

      • 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 Detail

      • 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 Detail

      • 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:
        file if success

      • 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. Propergate to Lines/Taxes
        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 performed

      • 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) Incoming 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 Sets line ASI

      • 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)

      • reverseAccrualIt

        public boolean reverseAccrualIt()
        Reverse Accrual - none
        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
        Parameters:
        reversal - reversal

      • isReversal

        protected boolean isReversal()
        Is Reversal
        Returns:
        reversal

      • isComplete

        public boolean isComplete()
        Document Status is Complete or Closed
        Returns:
        true if CO, CL or RE