Package org.compiere.model

Class MBankStatement

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_C_BankStatement

org.compiere.model.MBankStatement

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_C_BankStatement, I_Persistent, DocAction, Evaluatee

public class MBankStatement
extends X_C_BankStatement
implements DocAction

Bank Statement Model

Version:

$Id: MBankStatement.java,v 1.3 2006/07/30 00:51:03 jjanke Exp $

Author:

Eldir Tomassen/Jorg Janke, victor.perez@e-evolution.com, e-Evolution http://www.e-evolution.com

BF [ 1933645 ] Wrong balance Bank Statement, Teo Sarca, http://www.arhipac.ro

FR [ 2616330 ] Use MPeriod.testPeriodOpen instead of isOpen https://sourceforge.net/p/adempiere/feature-requests/666/

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_justPrepared	Just Prepared Flag
protected MBankStatementLine[]	m_lines	Lines
protected String	m_processMsg	Process Message

Fields inherited from class org.compiere.model.X_C_BankStatement

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

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, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, 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_Reverse_Accrual, ACTION_Reverse_Correct, ACTION_Unlock, ACTION_Void, ACTION_WaitComplete, AD_REFERENCE_ID, DOC_COLUMNNAME_AD_User_ID, DOC_COLUMNNAME_C_Currency_ID, DOC_COLUMNNAME_C_DocType_ID, DOC_COLUMNNAME_C_DocTypeTarget_ID, DOC_COLUMNNAME_DateAcct, DOC_COLUMNNAME_DateTrx, DOC_COLUMNNAME_Description, DOC_COLUMNNAME_DocAction, DOC_COLUMNNAME_DocStatus, DOC_COLUMNNAME_DocumentNo, DOC_COLUMNNAME_IsApproved, DOC_COLUMNNAME_Processed, DOC_COLUMNNAME_Processing, DOC_COLUMNNAME_SalesRep_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_BankStatement

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_BeginningBalance, COLUMNNAME_C_BankAccount_ID, COLUMNNAME_C_BankStatement_ID, COLUMNNAME_C_BankStatement_UU, COLUMNNAME_C_DocType_ID, COLUMNNAME_CopyFrom, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_CreateFrom, COLUMNNAME_CreateFromBatch, COLUMNNAME_DateAcct, COLUMNNAME_Description, COLUMNNAME_DocAction, COLUMNNAME_DocStatus, COLUMNNAME_DocumentNo, COLUMNNAME_EftStatementDate, COLUMNNAME_EftStatementReference, COLUMNNAME_EndingBalance, COLUMNNAME_IsActive, COLUMNNAME_IsApproved, COLUMNNAME_IsManual, COLUMNNAME_MatchStatement, COLUMNNAME_Name, COLUMNNAME_Posted, COLUMNNAME_Processed, COLUMNNAME_ProcessedOn, COLUMNNAME_Processing, COLUMNNAME_StatementDate, COLUMNNAME_StatementDifference, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MBankStatement(Properties ctx, int C_BankStatement_ID, String trxName)	Standard Constructor
MBankStatement(Properties ctx, String C_BankStatement_UU, String trxName)	UUID based Constructor
MBankStatement(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MBankStatement(MBankAccount account)	Create a new Bank Statement
MBankStatement(MBankAccount account, boolean isManual)	Parent Constructor

Method Summary

Modifier and Type	Method	Description
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
BigDecimal	getApprovalAmt()	Get Document Approval Amount.
MBankAccount	getBankAccount()	Get Bank Account
int	getC_Currency_ID()	Get Document Currency
int	getDoc_User_ID()	Get Document Owner (Responsible)
String	getDocumentInfo()	Get Document Info
String	getDocumentNo()	Get Document No
MBankStatementLine[]	getLines(boolean requery)	Get Bank Statement Lines
String	getProcessMsg()	Get Process Message
String	getSummary()	Get Summary
boolean	invalidateIt()	Invalidate Document
boolean	isComplete()	Document Status is Complete, Closed or Reversed
static boolean	isPostWithDateFromLine(int clientID)
String	prepareIt()	Prepare Document
boolean	processIt(String processAction)	Process document
boolean	reActivateIt()	Re-activate
boolean	rejectIt()	Reject Approval
boolean	reverseAccrualIt()	Reverse Accrual
boolean	reverseCorrectIt()	Reverse Correction
protected void	setDefiniteDocumentNo()	Set the definite document number after completed
void	setProcessed(boolean processed)	Set Processed.
boolean	unlockIt()	Unlock Document.
boolean	voidIt()	Void Document.

Methods inherited from class org.compiere.model.X_C_BankStatement

get_AccessLevel, getBeginningBalance, getC_BankAccount, getC_BankAccount_ID, getC_BankStatement_ID, getC_BankStatement_UU, getC_DocType, getC_DocType_ID, getCopyFrom, getCreateFrom, getCreateFromBatch, getDateAcct, getDescription, getDocAction, getDocStatus, getEftStatementDate, getEftStatementReference, getEndingBalance, getKeyNamePair, getMatchStatement, getName, getProcessedOn, getStatementDate, getStatementDifference, initPO, isApproved, isManual, isPosted, isProcessed, isProcessing, setBeginningBalance, setC_BankAccount_ID, setC_BankStatement_ID, setC_BankStatement_UU, setC_DocType_ID, setCopyFrom, setCreateFrom, setCreateFromBatch, setDateAcct, setDescription, setDocAction, setDocStatus, setDocumentNo, setEftStatementDate, setEftStatementReference, setEndingBalance, setIsApproved, setIsManual, setMatchStatement, setName, setPosted, setProcessedOn, setProcessing, setStatementDate, setStatementDifference, toString

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, 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_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

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, saveEx, setDocStatus

Methods inherited from interface org.compiere.model.I_C_BankStatement

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Field Details

m_lines

protected MBankStatementLine[] m_lines

Lines

m_processMsg

protected String m_processMsg

Process Message

m_justPrepared

protected boolean m_justPrepared

Just Prepared Flag

Constructor Details

MBankStatement

public MBankStatement(Properties ctx,
 String C_BankStatement_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

C_BankStatement_UU - UUID key

trxName - Transaction

MBankStatement

public MBankStatement(Properties ctx,
 int C_BankStatement_ID,
 String trxName)

Standard Constructor

Parameters:

ctx - context

C_BankStatement_ID - id

trxName - transaction

MBankStatement

public MBankStatement(Properties ctx,
 ResultSet rs,
 String trxName)

Load Constructor

Parameters:

ctx - Current context

rs - result set

trxName - transaction

MBankStatement

public MBankStatement(MBankAccount account,
 boolean isManual)

Parent Constructor

Parameters:

account - Bank Account

isManual - Manual statement

MBankStatement

public MBankStatement(MBankAccount account)

Create a new Bank Statement

Parameters:

account - Bank Account

Method Details

getLines

public MBankStatementLine[] getLines(boolean requery)

Get Bank Statement Lines

Parameters:

requery - true to always re-query from DB

Returns:

statement line array

addDescription

public void addDescription(String description)

Add to Description

Parameters:

description - text

setProcessed

public void setProcessed(boolean processed)

Set Processed. Propagate to Lines.

Specified by:

setProcessed in interface I_C_BankStatement

Overrides:

setProcessed in class X_C_BankStatement

Parameters:

processed - processed

getBankAccount

public MBankAccount getBankAccount()

Get Bank Account

Returns:

bank Account

getDocumentNo

public String getDocumentNo()

Get Document No

Specified by:

getDocumentNo in interface DocAction

Specified by:

getDocumentNo in interface I_C_BankStatement

Overrides:

getDocumentNo in class X_C_BankStatement

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:

PDF File or null

createPDF

public File createPDF(File file)

Create PDF file

Parameters:

file - output file

Returns:

not implemented, always return null

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save

Overrides:

beforeSave in class PO

Parameters:

newRecord - new

Returns:

true

processIt

public boolean processIt(String processAction)

Process document

Specified by:

processIt in interface DocAction

Parameters:

processAction - document action

Returns:

true if success

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:

true if successfully voided

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:

true if success

reverseAccrualIt

public boolean reverseAccrualIt()

Reverse Accrual

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

getApprovalAmt

public BigDecimal getApprovalAmt()

Get Document Approval Amount.

Specified by:

getApprovalAmt in interface DocAction

Returns:

Statement Difference

getC_Currency_ID

public int getC_Currency_ID()

Get Document Currency

Specified by:

getC_Currency_ID in interface DocAction

Returns:

C_Currency_ID

isComplete

public boolean isComplete()

Document Status is Complete, Closed or Reversed

Returns:

true if CO, CL or RE

isPostWithDateFromLine

public static boolean isPostWithDateFromLine(int clientID)

Parameters:

clientID -

Returns:

true if bank statement posting should use accounting date from bank statement lines.