Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Adempiere 3.5.2a
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.compiere.model
Class MCash

java.lang.Object
  extended by org.compiere.model.PO
      extended by org.compiere.model.X_C_Cash
          extended by org.compiere.model.MCash
All Implemented Interfaces:
Serializable, Comparator, I_C_Cash, I_Persistent, DocAction, Evaluatee
public class MCash
extends X_C_Cash
implements DocAction

Cash Journal Model

Version:
$Id: MCash.java,v 1.3 2006/07/30 00:51:03 jjanke Exp $
Author:
Jorg Janke, victor.perez@e-evolution.com www.e-evolution.com FR [ 1866214 ] http://sourceforge.net/tracker/index.php?func=detail&aid=1866214&group_id=176962&atid=879335, Teo Sarca, SC ARHIPAC SERVICE SRL
  • BF [ 1831997 ] Cash journal allocation reversed
  • BF [ 1894524 ] Pay an reversed invoice
    • See Also:
    Serialized Form

    Field Summary
     
    Fields inherited from class org.compiere.model.X_C_Cash
    AD_ORGTRX_ID_AD_Reference_ID, 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, 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.process.DocAction
    ACTION_Approve, ACTION_Close, ACTION_Complete, ACTION_Invalidate, ACTION_None, ACTION_Post, ACTION_Prepare, ACTION_ReActivate, ACTION_Reject, ACTION_ReOpen, ACTION_Reverse_Accrual, ACTION_Reverse_Correct, ACTION_Unlock, ACTION_Void, ACTION_WaitComplete, AD_REFERENCE_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_C_Cash
    accessLevel, COLUMNNAME_AD_OrgTrx_ID, COLUMNNAME_BeginningBalance, COLUMNNAME_C_Activity_ID, COLUMNNAME_C_Campaign_ID, COLUMNNAME_C_Cash_ID, COLUMNNAME_C_CashBook_ID, COLUMNNAME_C_Project_ID, COLUMNNAME_DateAcct, COLUMNNAME_Description, COLUMNNAME_DocAction, COLUMNNAME_DocStatus, COLUMNNAME_EndingBalance, COLUMNNAME_IsApproved, COLUMNNAME_Name, COLUMNNAME_Posted, COLUMNNAME_Processed, COLUMNNAME_Processing, COLUMNNAME_StatementDate, COLUMNNAME_StatementDifference, COLUMNNAME_User1_ID, COLUMNNAME_User2_ID, Model, Table_ID, Table_Name
     
    Constructor Summary
    MCash(MCashBook cb, Timestamp today)
              Parent Constructor
    MCash(Properties ctx, int C_Cash_ID, String trxName)
              Standard Constructor
    MCash(Properties ctx, ResultSet rs, String trxName)
              Load Constructor
     
    Method Summary
     void addDescription(String description)
              Add to Description
     boolean approveIt()
              Approve Document
    protected  boolean beforeSave(boolean newRecord)
              Before Save
     boolean closeIt()
              Close Document.
     String completeIt()
              Complete Document
     File createPDF()
              Create PDF
     File createPDF(File file)
              Create PDF file
    static MCash get(Properties ctx, int AD_Org_ID, Timestamp dateAcct, int C_Currency_ID, String trxName)
              Get Cash Journal for currency, org and date
    static MCash get(Properties ctx, int C_CashBook_ID, Timestamp dateAcct, String trxName)
              Get Cash Journal for CashBook and date
     BigDecimal getApprovalAmt()
              Get Document Approval Amount
     int getC_Currency_ID()
              Get Currency
     MCashBook getCashBook()
              Get Cash Book
     int getDoc_User_ID()
              Get Document Owner (Responsible)
     String getDocumentInfo()
              Get Document Info
     String getDocumentNo()
              Get Document No
     MCashLine[] getLines(boolean requery)
              Get Lines
     String getProcessMsg()
              Get Process Message
     String getSummary()
              Get Summary
     boolean invalidateIt()
              Invalidate Document
     String prepareIt()
              Prepare Document
     boolean processIt(String processAction)
              Process document
     boolean reActivateIt()
              Re-activate
     boolean rejectIt()
              Reject Approval
     boolean reverseAccrualIt()
              Reverse Accrual - none
     boolean reverseCorrectIt()
              Reverse Correction
     void setProcessed(boolean processed)
              Set Processed
     String toString()
              String Representation
     boolean unlockIt()
              Unlock Document.
     boolean voidIt()
              Void Document.
     
    Methods inherited from class org.compiere.model.X_C_Cash
    get_AccessLevel, getAD_OrgTrx_ID, getBeginningBalance, getC_Activity_ID, getC_Activity, getC_Campaign_ID, getC_Campaign, getC_Cash_ID, getC_CashBook_ID, getC_CashBook, getC_Project_ID, getC_Project, getDateAcct, getDescription, getDocAction, getDocStatus, getEndingBalance, getKeyNamePair, getName, getStatementDate, getStatementDifference, getUser1_ID, getUser2_ID, initPO, isApproved, isPosted, isProcessed, isProcessing, setAD_OrgTrx_ID, setBeginningBalance, setC_Activity_ID, setC_Campaign_ID, setC_Cash_ID, setC_CashBook_ID, setC_Project_ID, setDateAcct, setDescription, setDocAction, setDocStatus, setEndingBalance, setIsApproved, setName, setPosted, setProcessing, setStatementDate, setStatementDifference, setUser1_ID, setUser2_ID
     
    Methods inherited from class org.compiere.model.PO
    afterDelete, afterSave, 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.process.DocAction
    get_ID, get_Logger, get_Table_ID, get_TrxName, getAD_Client_ID, getAD_Org_ID, getCtx, getDocAction, getDocStatus, save, setDocStatus
     
    Methods inherited from interface org.compiere.model.I_Persistent
    save
     

    Constructor Detail

    MCash

    public MCash(Properties ctx,
             int C_Cash_ID,
             String trxName)
    Standard Constructor

    Parameters:
    ctx - context
    C_Cash_ID - id
    trxName - transaction

    MCash

    public MCash(Properties ctx,
             ResultSet rs,
             String trxName)
    Load Constructor

    Parameters:
    ctx - context
    rs - result set
    trxName - transaction

    MCash

    public MCash(MCashBook cb,
             Timestamp today)
    Parent Constructor

    Parameters:
    cb - cash book
    today - date - if null today
    Method Detail

    get

    public static MCash get(Properties ctx,
                        int AD_Org_ID,
                        Timestamp dateAcct,
                        int C_Currency_ID,
                        String trxName)
    Get Cash Journal for currency, org and date

    Parameters:
    ctx - context
    C_Currency_ID - currency
    AD_Org_ID - org
    dateAcct - date
    trxName - transaction
    Returns:
    cash

    get

    public static MCash get(Properties ctx,
                        int C_CashBook_ID,
                        Timestamp dateAcct,
                        String trxName)
    Get Cash Journal for CashBook and date

    Parameters:
    ctx - context
    C_CashBook_ID - cashbook
    dateAcct - date
    trxName - transaction
    Returns:
    cash

    getLines

    public MCashLine[] getLines(boolean requery)
    Get Lines

    Parameters:
    requery - requery
    Returns:
    lines

    getCashBook

    public MCashBook getCashBook()
    Get Cash Book

    Returns:
    cash book

    getDocumentNo

    public String getDocumentNo()
    Get Document No

    Specified by:
    getDocumentNo in interface DocAction
    Returns:
    name

    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 -
    Returns:
    true

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

    voidIt

    public boolean voidIt()
    Void Document. Same as Close.

    Specified by:
    voidIt in interface DocAction
    Returns:
    true if success

    addDescription

    public void addDescription(String description)
    Add to Description

    Parameters:
    description - text

    closeIt

    public boolean closeIt()
    Close Document. Cancel not delivered Quantities

    Specified by:
    closeIt in interface DocAction
    Returns:
    true if success

    reverseCorrectIt

    public boolean reverseCorrectIt()
    Reverse Correction

    Specified by:
    reverseCorrectIt in interface DocAction
    Returns:
    true if success

    reverseAccrualIt

    public boolean reverseAccrualIt()
    Reverse Accrual - none

    Specified by:
    reverseAccrualIt in interface DocAction
    Returns:
    true if success

    reActivateIt

    public boolean reActivateIt()
    Re-activate

    Specified by:
    reActivateIt in interface DocAction
    Returns:
    true if success

    setProcessed

    public void setProcessed(boolean processed)
    Set Processed

    Specified by:
    setProcessed in interface I_C_Cash
    Overrides:
    setProcessed in class X_C_Cash
    Parameters:
    processed - processed

    toString

    public String toString()
    String Representation

    Overrides:
    toString in class X_C_Cash
    Returns:
    info

    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

    getApprovalAmt

    public BigDecimal getApprovalAmt()
    Get Document Approval Amount

    Specified by:
    getApprovalAmt in interface DocAction
    Returns:
    amount difference

    getC_Currency_ID

    public int getC_Currency_ID()
    Get Currency

    Specified by:
    getC_Currency_ID in interface DocAction
    Returns:
    Currency
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    		Adempiere 3.5.2a
     PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
    SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
    Adempiere® is a registered trademark of ADempiere Business Inc. ©2004-2008 HumanFlash.com All rights reserved.