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
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanJust Prepared Flagprotected MBankStatementLine[]Linesprotected StringProcess MessageFields 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_WaitingPaymentFields 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_IDFields 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_WaitingPaymentFields 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
ConstructorsConstructorDescriptionMBankStatement(Properties ctx, int C_BankStatement_ID, String trxName) Standard ConstructorMBankStatement(Properties ctx, String C_BankStatement_UU, String trxName) UUID based ConstructorMBankStatement(Properties ctx, ResultSet rs, String trxName) Load ConstructorMBankStatement(MBankAccount account) Create a new Bank StatementMBankStatement(MBankAccount account, boolean isManual) Parent Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDescription(String description) Add to DescriptionbooleanApprove Documentprotected booleanbeforeSave(boolean newRecord) Called before Save for Pre-Save Operation.
Default implementation is nop, to be implemented in sub-classes that needed it.booleancloseIt()Close Document.Complete DocumentCreate PDFCreate PDF fileGet Document Approval Amount.Get Bank AccountintGet Document CurrencyintGet Document Owner (Responsible)Get Document InfoGet Document NogetLines(boolean requery) Get Bank Statement LinesGet Process MessageGet SummarybooleanInvalidate DocumentbooleanDocument Status is Complete, Closed or Reversedstatic booleanisPostWithDateFromLine(int clientID) Prepare DocumentbooleanProcess documentbooleanRe-activatebooleanrejectIt()Reject ApprovalbooleanReverse AccrualbooleanReverse Correctionprotected voidSet the definite document number after completedvoidsetProcessed(boolean processed) Set Processed.booleanunlockIt()Unlock Document.booleanvoidIt()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, toStringMethods 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_TableAttribute, get_TableAttributeAsBoolean, get_TableAttributeAsInt, get_TableAttributes, 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, validForeignKeysExMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLongMethods 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, setDocStatusMethods inherited from interface org.compiere.model.I_C_BankStatement
getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActiveMethods inherited from interface org.compiere.model.I_Persistent
save
-
Field Details
-
m_lines
Lines -
m_processMsg
Process Message -
m_justPrepared
protected boolean m_justPreparedJust Prepared Flag
-
-
Constructor Details
-
MBankStatement
UUID based Constructor- Parameters:
ctx- ContextC_BankStatement_UU- UUID keytrxName- Transaction
-
MBankStatement
Standard Constructor- Parameters:
ctx- contextC_BankStatement_ID- idtrxName- transaction
-
MBankStatement
Load Constructor- Parameters:
ctx- Current contextrs- result settrxName- transaction
-
MBankStatement
Parent Constructor- Parameters:
account- Bank AccountisManual- Manual statement
-
MBankStatement
Create a new Bank Statement- Parameters:
account- Bank Account
-
-
Method Details
-
getLines
Get Bank Statement Lines- Parameters:
requery- true to always re-query from DB- Returns:
- statement line array
-
addDescription
Add to Description- Parameters:
description- text
-
setProcessed
public void setProcessed(boolean processed) Set Processed. Propagate to Lines.- Specified by:
setProcessedin interfaceI_C_BankStatement- Overrides:
setProcessedin classX_C_BankStatement- Parameters:
processed- processed
-
getBankAccount
Get Bank Account- Returns:
- bank Account
-
getDocumentNo
Get Document No- Specified by:
getDocumentNoin interfaceDocAction- Specified by:
getDocumentNoin interfaceI_C_BankStatement- Overrides:
getDocumentNoin classX_C_BankStatement- Returns:
- name
-
getDocumentInfo
Get Document Info- Specified by:
getDocumentInfoin interfaceDocAction- Returns:
- document info (untranslated)
-
createPDF
Create PDF -
createPDF
Create PDF file- Parameters:
file- output file- Returns:
- not implemented, always return null
-
beforeSave
protected boolean beforeSave(boolean newRecord) Description copied from class:POCalled before Save for Pre-Save Operation.
Default implementation is nop, to be implemented in sub-classes that needed it.- Overrides:
beforeSavein classPO- Parameters:
newRecord- true if it is a new record- Returns:
- true if record can be saved
-
processIt
Process document -
unlockIt
public boolean unlockIt()Unlock Document. -
invalidateIt
public boolean invalidateIt()Invalidate Document- Specified by:
invalidateItin interfaceDocAction- Returns:
- true if success
-
prepareIt
Prepare Document -
approveIt
public boolean approveIt()Approve Document -
rejectIt
public boolean rejectIt()Reject Approval -
completeIt
Complete Document- Specified by:
completeItin interfaceDocAction- 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. -
closeIt
public boolean closeIt()Close Document. -
reverseCorrectIt
public boolean reverseCorrectIt()Reverse Correction- Specified by:
reverseCorrectItin interfaceDocAction- Returns:
- true if success
-
reverseAccrualIt
public boolean reverseAccrualIt()Reverse Accrual- Specified by:
reverseAccrualItin interfaceDocAction- Returns:
- false
-
reActivateIt
public boolean reActivateIt()Re-activate- Specified by:
reActivateItin interfaceDocAction- Returns:
- true if success
-
getSummary
Get Summary- Specified by:
getSummaryin interfaceDocAction- Returns:
- Summary of Document
-
getProcessMsg
Get Process Message- Specified by:
getProcessMsgin interfaceDocAction- Returns:
- clear text error message
-
getDoc_User_ID
public int getDoc_User_ID()Get Document Owner (Responsible)- Specified by:
getDoc_User_IDin interfaceDocAction- Returns:
- AD_User_ID
-
getApprovalAmt
Get Document Approval Amount.- Specified by:
getApprovalAmtin interfaceDocAction- Returns:
- Statement Difference
-
getC_Currency_ID
public int getC_Currency_ID()Get Document Currency- Specified by:
getC_Currency_IDin interfaceDocAction- 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.
-