Package org.compiere.model

Class MJournalBatch

java.lang.Object
org.compiere.model.PO
org.compiere.model.X_GL_JournalBatch
org.compiere.model.MJournalBatch
All Implemented Interfaces:
Serializable, Cloneable, Comparator<Object>, I_GL_JournalBatch, I_Persistent, DocAction, Evaluatee
public class MJournalBatch extends X_GL_JournalBatch implements DocAction
Journal Batch Model
Version:
$Id: MJournalBatch.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, Teo Sarca, www.arhipac.ro
  • FR [ 1776045 ] Add ReActivate action to GL Journal
    • See Also:

    • Field Details

      • m_processMsg

        protected String m_processMsg
        Process Message

      • m_justPrepared

        protected boolean m_justPrepared
        Just Prepared Flag

    • Constructor Details

      • MJournalBatch

        public MJournalBatch(Properties ctx, String GL_JournalBatch_UU, String trxName)
        UUID based Constructor
        Parameters:
        ctx - Context
        GL_JournalBatch_UU - UUID key
        trxName - Transaction

      • MJournalBatch

        public MJournalBatch(Properties ctx, int GL_JournalBatch_ID, String trxName)
        Parameters:
        ctx - context
        GL_JournalBatch_ID - id if 0 - create actual batch
        trxName - transaction

      • MJournalBatch

        public MJournalBatch(Properties ctx, ResultSet rs, String trxName)
        Load Constructor
        Parameters:
        ctx - context
        rs - result set
        trxName - transaction

      • MJournalBatch

        public MJournalBatch(MJournalBatch original)
        Copy Constructor. Does not copy: Dates/Period
        Parameters:
        original - original

    • Method Details

      • copyFrom

        public static MJournalBatch copyFrom(Properties ctx, int GL_JournalBatch_ID, Timestamp dateDoc, String trxName)
        Create new Journal Batch by copying
        Parameters:
        ctx - context
        GL_JournalBatch_ID - journal batch
        dateDoc - date of the document date
        trxName - transaction
        Returns:
        Journal Batch

      • setClientOrg

        public void setClientOrg(int AD_Client_ID, int AD_Org_ID)
        Overwrite Client/Org if required
        Overrides:
        setClientOrg in class PO
        Parameters:
        AD_Client_ID - client
        AD_Org_ID - org

      • setDateAcct

        public void setDateAcct(Timestamp DateAcct)
        Set Accounting Date. Set also Period if not set earlier.
        Specified by:
        setDateAcct in interface I_GL_JournalBatch
        Overrides:
        setDateAcct in class X_GL_JournalBatch
        Parameters:
        DateAcct - date

      • getJournals

        public MJournal[] getJournals(boolean requery)
        Get Journal Lines
        Parameters:
        requery - ignore
        Returns:
        Array of lines

      • copyDetailsFrom

        public int copyDetailsFrom(MJournalBatch jb)
        Copy Journal/Lines from other Journal Batch
        Parameters:
        jb - Journal Batch
        Returns:
        number of journals + lines copied

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

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

      • setDefiniteDocumentNo

        protected void setDefiniteDocumentNo()
        Set the definite document number after completed

      • voidIt

        public boolean voidIt()
        Void Document.
        Specified by:
        voidIt in interface DocAction
        Returns:
        false

      • closeIt

        public boolean closeIt()
        Close Document.
        Specified by:
        closeIt in interface DocAction
        Returns:
        true if success

      • reverseCorrectIt

        public boolean reverseCorrectIt()
        Reverse Correction. Flip Dr/Cr - Use this document's date.
        Specified by:
        reverseCorrectIt in interface DocAction
        Returns:
        true if success

      • reverseAccrualIt

        public boolean reverseAccrualIt()
        Reverse Accrual. Flip Dr/Cr - Use Today's date.
        Specified by:
        reverseAccrualIt in interface DocAction
        Returns:
        true if success

      • reActivateIt

        public boolean reActivateIt()
        Re-activate document and delete Fact_Acct entries.
        Specified by:
        reActivateIt in interface DocAction
        Returns:
        true if success

      • getSummary

        public String getSummary()
        Get Summary
        Specified by:
        getSummary in interface DocAction
        Returns:
        Summary of Document

      • toString

        public String toString()
        String Representation
        Overrides:
        toString in class X_GL_JournalBatch
        Returns:
        info

      • 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

      • 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 (Created By)

      • getApprovalAmt

        public BigDecimal getApprovalAmt()
        Get Document Approval Amount
        Specified by:
        getApprovalAmt in interface DocAction
        Returns:
        DR amount

      • addDescription

        public void addDescription(String description)
        append description to current Description text
        Parameters:
        description -

      • beforeSave

        protected boolean beforeSave(boolean newRecord)
        Description copied from class: PO
        Called before Save for Pre-Save Operation.
        Default implementation is nop, to be implemented in sub-classes that needed it.
        Overrides:
        beforeSave in class PO
        Parameters:
        newRecord - true if it is a new record
        Returns:
        true if record can be saved

      • isComplete

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