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, Evaluatee

public class MDepositBatch
extends X_C_DepositBatch

Deposit Batch Model

Version:

$Id: MDepositBatch.java,v 1.3 2007/06/28 00:51:03 afalcone Exp $

Author:

Alejandro Falcone

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_C_DepositBatch

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, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_C_DepositBatch

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_C_BankAccount_ID, COLUMNNAME_C_DepositBatch_ID, COLUMNNAME_C_DepositBatch_UU, COLUMNNAME_C_DocType_ID, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_CreateFrom, COLUMNNAME_DateDeposit, COLUMNNAME_DateDoc, COLUMNNAME_DepositAmt, COLUMNNAME_Description, COLUMNNAME_DocStatus, COLUMNNAME_DocumentNo, COLUMNNAME_IsActive, COLUMNNAME_Processed, COLUMNNAME_Processing, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MDepositBatch(Properties ctx, int C_DepositBatch_ID, String trxName)	Create and Load existing Persistent Object
MDepositBatch(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MDepositBatch(MDepositBatch original)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	afterDelete(boolean success)	After Delete
File	createPDF()	Create PDF
File	createPDF(File file)	Create PDF file
BigDecimal	getApprovalAmt()	Get Document Approval Amount
int	getDoc_User_ID()	Get Document Owner (Responsible)
String	getDocumentInfo()	Get Document Info
MDepositBatchLine[]	getLines()	Get Deposit Batch Lines
String	getProcessMsg()	Get Process Message
boolean	invalidateIt()	Invalidate Document
boolean	isComplete()	Document Status is Complete or Closed
void	setClientOrg(int AD_Client_ID, int AD_Org_ID)	Overwrite Client/Org if required
void	setDateAcct(Timestamp DateAcct)	Set Accounting Date.
String	toString()	String Representation
boolean	unlockIt()	Unlock Document.
boolean	voidIt()	Void Document.

Methods inherited from class org.compiere.model.X_C_DepositBatch

get_AccessLevel, getC_BankAccount, getC_BankAccount_ID, getC_DepositBatch_ID, getC_DepositBatch_UU, getC_DocType, getC_DocType_ID, getCreateFrom, getDateDeposit, getDateDoc, getDepositAmt, getDescription, getDocStatus, getDocumentNo, getKeyNamePair, initPO, isProcessed, isProcessing, setC_BankAccount_ID, setC_DepositBatch_ID, setC_DepositBatch_UU, setC_DocType_ID, setCreateFrom, setDateDeposit, setDateDoc, setDepositAmt, setDescription, setDocStatus, setDocumentNo, setProcessed, setProcessing

Methods inherited from class org.compiere.model.PO

afterSave, beforeDelete, beforeSave, 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_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, 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, load, loadByUU, loadComplete, loadDefaults, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, 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, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, 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.model.I_C_DepositBatch

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

Constructor Detail

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)

Copy Constructor. Dos not copy: Dates/Period

Parameters:

original - original

Method Detail

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 Accounting Date. Set also Period if not set earlier

Parameters:

DateAcct - date

unlockIt

public boolean unlockIt()

Unlock Document.

Returns:

true if success

invalidateIt

public boolean invalidateIt()

Invalidate Document

Returns:

true if success

voidIt

public boolean voidIt()

Void Document.

Returns:

false

toString

public String toString()

String Representation

Overrides:

toString in class X_C_DepositBatch

Returns:

info

getDocumentInfo

public String getDocumentInfo()

Get Document Info

Returns:

document info (untranslated)

createPDF

public File createPDF()

Create PDF

Returns:

File or null

createPDF

public File createPDF(File file)

Create PDF file

Parameters:

file - output file

Returns:

file if success

getProcessMsg

public String getProcessMsg()

Get Process Message

Returns:

clear text error message

getDoc_User_ID

public int getDoc_User_ID()

Get Document Owner (Responsible)

Returns:

AD_User_ID (Created By)

getApprovalAmt

public BigDecimal getApprovalAmt()

Get Document Approval Amount

Returns:

DR amount

afterDelete

protected boolean afterDelete(boolean success)

After Delete

Overrides:

afterDelete in class PO

Parameters:

success - success

Returns:

success

getLines

public MDepositBatchLine[] getLines()

Get Deposit Batch Lines

Returns:

Array of lines

isComplete

public boolean isComplete()

Document Status is Complete or Closed

Returns:

true if CO, CL or RE