Package org.compiere.model

Class MDepositBatch

java.lang.Object
org.compiere.model.PO
org.compiere.model.X_C_DepositBatch
org.compiere.model.MDepositBatch
All Implemented Interfaces:
Serializable, Cloneable, Comparator<Object>, I_C_DepositBatch, I_Persistent, DocAction, Evaluatee
public class MDepositBatch extends X_C_DepositBatch implements DocAction
Deposit Batch Model
Version:
$Id: MDepositBatch.java,v 1.3 2007/06/28 00:51:03 afalcone Exp $
Author:
Alejandro Falcone
See Also:

  • Field Details

    • m_justPrepared

      protected boolean m_justPrepared
      Just Prepared Flag

  • Constructor Details

    • MDepositBatch

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

    • MDepositBatch

      public MDepositBatch(Properties ctx, int C_DepositBatch_ID, String trxName)
      Create and Load existing Persistent Object
      Parameters:
      ctx - context
      C_DepositBatch_ID - The unique ID of the object
      trxName - transaction name

    • MDepositBatch

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

    • MDepositBatch

      public MDepositBatch(MDepositBatch original)
      Create new deposit batch from original.
      Copy over ad_client_id, ad_org_id, c_depositbatch_id, description, c_doctype_id, datedoc, datedeposit and depositamt.
      Parameters:
      original - original

  • Method Details

    • 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

    • 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 Date Deposit
      Parameters:
      DateAcct - date

    • unlockIt

      @Deprecated public boolean unlockIt()
      Deprecated.
      incomplete/abandon implementation of DocAction interface
      Unlock Document.
      Specified by:
      unlockIt in interface DocAction
      Returns:
      true if success

    • invalidateIt

      public boolean invalidateIt()
      Deprecated.
      incomplete/abandon implementation of DocAction interface
      Invalidate Document
      Specified by:
      invalidateIt in interface DocAction
      Returns:
      true if success

    • voidIt

      public boolean voidIt()
      Deprecated.
      incomplete/abandon implementation of DocAction interface
      Void Document.
      Specified by:
      voidIt in interface DocAction
      Returns:
      false

    • toString

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

    • getDocumentInfo

      @Deprecated public String getDocumentInfo()
      Deprecated.
      incomplete/abandon implementation of DocAction interface
      Get Document Info
      Specified by:
      getDocumentInfo in interface DocAction
      Returns:
      document info (untranslated)

    • createPDF

      @Deprecated public File createPDF()
      Deprecated.
      incomplete/abandon implementation of DocAction interface
      Create PDF
      Specified by:
      createPDF in interface DocAction
      Returns:
      File or null

    • createPDF

      @Deprecated public File createPDF(File file)
      Deprecated.
      incomplete/abandon implementation of DocAction interface
      Create PDF file
      Parameters:
      file - output file
      Returns:
      file if success

    • getProcessMsg

      @Deprecated public String getProcessMsg()
      Deprecated.
      incomplete/abandon implementation of DocAction interface
      Get Process Message
      Specified by:
      getProcessMsg in interface DocAction
      Returns:
      clear text error message

    • getDoc_User_ID

      @Deprecated public int getDoc_User_ID()
      Deprecated.
      incomplete/abandon implementation of DocAction interface
      Get Document Owner (Responsible)
      Specified by:
      getDoc_User_ID in interface DocAction
      Returns:
      AD_User_ID (Created By)

    • getApprovalAmt

      @Deprecated public BigDecimal getApprovalAmt()
      Deprecated.
      incomplete/abandon implementation of DocAction interface
      Get Document Approval Amount
      Specified by:
      getApprovalAmt in interface DocAction
      Returns:
      DR amount

    • afterDelete

      protected boolean afterDelete(boolean success)
      Description copied from class: PO
      Execute after Delete operations.
      Default implementation is nop, to be implemented in sub-classes that needed it.
      Overrides:
      afterDelete in class PO
      Parameters:
      success - true if record deleted
      Returns:
      true if delete is a success

    • getLines

      public MDepositBatchLine[] getLines()
      Get Deposit Batch Lines
      Returns:
      Array of lines (MDepositBatchLine)

    • isComplete

      @Deprecated public boolean isComplete()
      Deprecated.
      incomplete/abandon implementation of DocAction interface
      Document Status is Complete or Closed
      Returns:
      true if CO, CL or RE

    • processIt

      public boolean processIt(String action) throws Exception
      Process document
      Specified by:
      processIt in interface DocAction
      Parameters:
      processAction - document action
      Returns:
      true if performed
      Throws:
      Exception

    • prepareIt

      public String prepareIt()
      Description copied from interface: DocAction
      Prepare Document for a document action
      Specified by:
      prepareIt in interface DocAction
      Returns:
      new status (In Progress or Invalid)

    • approveIt

      public boolean approveIt()
      Description copied from interface: DocAction
      Approve Document
      Specified by:
      approveIt in interface DocAction
      Returns:
      true if success

    • rejectIt

      public boolean rejectIt()
      Description copied from interface: DocAction
      Reject Approval
      Specified by:
      rejectIt in interface DocAction
      Returns:
      true if success

    • completeIt

      public String completeIt()
      Description copied from interface: DocAction
      Complete Document
      Specified by:
      completeIt in interface DocAction
      Returns:
      new status (Complete, In Progress, Invalid, Waiting ..)

    • closeIt

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

    • reverseCorrectIt

      public boolean reverseCorrectIt()
      Description copied from interface: DocAction
      Reverse Correction
      Specified by:
      reverseCorrectIt in interface DocAction
      Returns:
      true if success

    • reverseAccrualIt

      public boolean reverseAccrualIt()
      Description copied from interface: DocAction
      Reverse Accrual
      Specified by:
      reverseAccrualIt in interface DocAction
      Returns:
      true if success

    • reActivateIt

      public boolean reActivateIt()
      Description copied from interface: DocAction
      Re-activate (typically from Complete to In Progress)
      Specified by:
      reActivateIt in interface DocAction
      Returns:
      true if success

    • addDescription

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

    • getSummary

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