org.compiere.model
Class MCash

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_C_Cash
          org.compiere.model.MCash

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, 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

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_C_Cash

accessLevel, 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, Model, Table_ID, Table_Name, updatedMS, USER1_ID_AD_Reference_ID, USER2_ID_AD_Reference_ID

Fields inherited from class org.compiere.framework.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, log, p_changeVO, 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, STATUS_Approved, STATUS_Closed, STATUS_Completed, STATUS_Drafted, STATUS_InProgress, STATUS_Invalid, STATUS_NotApproved, STATUS_Reversed, STATUS_Unknown, STATUS_Voided, STATUS_WaitingConfirmation, STATUS_WaitingPayment

Constructor Summary

MCash(Ctx ctx, int C_Cash_ID, String trxName)
Standard Constructor

MCash(Ctx ctx, ResultSet rs, String trxName)
Load Constructor

MCash(MCashBook cb, Timestamp today)
Parent Constructor

Method Summary

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(Ctx ctx, int AD_Org_ID, Timestamp dateAcct, int C_Currency_ID, String trxName) Get Cash Journal for currency, org and date
static MCash	get(Ctx 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
void	setStatementDate(String oldStatementDate, String newStatementDate, int windowNo) Set StatementDate - Callout
void	setStatementDate(Timestamp statementDate) Set Statement Date and Acct Date
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_Campaign_ID, getC_Cash_ID, getC_CashBook_ID, getC_Project_ID, getDateAcct, getDescription, getDocAction, getDocStatus, getEndingBalance, getKeyNamePair, getName, getStatementDate, getStatementDifference, getUser1_ID, getUser2_ID, initPO, isApproved, isDocActionValid, isDocStatusValid, 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, setStatementDifference, setUser1_ID, setUser2_ID

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, afterDelete, afterSave, beforeDelete, compare, convertToBigDecimal, convertToBoolean, convertToInt, convertToTimestamp, copy, copyValues, copyValues, createAttachment, delete_Accounting, delete, delete, dump, dump, equals, get_ChangeVO, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_EntityType, get_HashMap, get_ID, get_IDOld, get_Info, get_KeyColumns, get_Logger, get_Table_ID, get_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_ValuesAsString, get_WhereClause, get_xmlDocument, get_xmlString, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getVO, hashCode, insert_Accounting, is_Changed, is_KeyColumn, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveNew_getID, saveNewInsertSQL, saveNewSpecial, saveUpdate, set_ChangeVO, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueString, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setContext, setCtx, setDocWorkflowMgr, setIsActive, setStandardDefaults, setUpdateable, setUpdatedBy, toStringX, unlock, update

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

Constructor Detail

MCash

public MCash(Ctx ctx,
             int C_Cash_ID,
             String trxName)

Standard Constructor

Parameters:

ctx - context

C_Cash_ID - id

trxName - transaction

MCash

public MCash(Ctx 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(Ctx 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(Ctx 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

setStatementDate

@UICallout
public void setStatementDate(String oldStatementDate,
                                       String newStatementDate,
                                       int windowNo)
                      throws Exception

Set StatementDate - Callout

Parameters:

oldStatementDate - old

newStatementDate - new

windowNo - window no

Throws:

Exception

setStatementDate

public void setStatementDate(Timestamp statementDate)

Set Statement Date and Acct Date

Overrides:

setStatementDate in class X_C_Cash

Parameters:

statementDate - Date of the statement

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

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

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