org.compiere.model
Class MBankStatementLoader

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_C_BankStatementLoader
          org.compiere.model.MBankStatementLoader

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, Evaluatee

public class MBankStatementLoader
extends X_C_BankStatementLoader

Bank Statement Loader Model This class is responsible for creating an instance of the bank statement loader class to use. It also inserts the data into the I_BankStatement table. The loader objects can acces their configuration (e.g. file, URL, password etc) using the corresponding get methods provided by this class. As this class is derrived from PO, "Persistent Object" it has acces to the loader configuration that has been entered for this loader. How these values are interpreted is the responsibility of the loader. There are two file names provided, getFileName() and getLocalFileName(). The first one is the file name as entered on the loader configuration tab, the second one is the file name parameter from the loader process. Reccomended behaviour for a file based loader would be to use the file name from the process parameter if available, and resort to the file anme from the loader configuration as a second option. For a HTTP based loader the file name from the loader configuration should be used to construct the URL to connect to (combined with the other parameters). In this scenario the file name from the process parameter can be used to save the aquired statement data to disk. author Maarten Klinker, Eldir Tomassen

Version:

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

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_C_BankStatementLoader

accessLevel, Model, Table_ID, Table_Name, updatedMS

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

Constructor Summary

MBankStatementLoader(Ctx ctx, int C_BankStatementLoader_ID, String trxName)
Create a Statement Loader Added for compatibility with new PO infrastructure (bug# 968136)

MBankStatementLoader(Ctx ctx, int C_BankStatementLoader_ID, String fileName, String trxName)
Create a Statement Loader

MBankStatementLoader(Ctx ctx, ResultSet rs, String trxName)
Create a Statement Loader

Method Summary

String	getErrorDescription() Return the most recent error description
String	getErrorMessage() Return the most recent error
int	getLoadCount() The total number of statement lines loaded
String	getLocalFileName() Return Local File Name
boolean	loadLines() Start loading Bankstatements
boolean	saveLine() Load a bank statement into the I_BankStatement table
String	toString() Return Name

Methods inherited from class org.compiere.model.X_C_BankStatementLoader

get_AccessLevel, getAccountNo, getBranchID, getC_BankAccount_ID, getC_BankStatementLoader_ID, getDateFormat, getDateLastRun, getDescription, getFileName, getFinancialInstitutionID, getHostAddress, getHostPort, getKeyNamePair, getName, getPassword, getPIN, getProxyAddress, getProxyLogon, getProxyPassword, getProxyPort, getStmtLoaderClass, getUserID, initPO, setAccountNo, setBranchID, setC_BankAccount_ID, setC_BankStatementLoader_ID, setDateFormat, setDateLastRun, setDescription, setFileName, setFinancialInstitutionID, setHostAddress, setHostPort, setName, setPassword, setPIN, setProxyAddress, setProxyLogon, setProxyPassword, setProxyPort, setStmtLoaderClass, setUserID

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, afterDelete, afterSave, beforeDelete, beforeSave, 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

Constructor Detail

MBankStatementLoader

public MBankStatementLoader(Ctx ctx,
                            int C_BankStatementLoader_ID,
                            String trxName)

Create a Statement Loader Added for compatibility with new PO infrastructure (bug# 968136)

Parameters:

ctx - Current context

C_BankStatementLoader_ID - loader to use

trxName - transaction

MBankStatementLoader

public MBankStatementLoader(Ctx ctx,
                            int C_BankStatementLoader_ID,
                            String fileName,
                            String trxName)

Create a Statement Loader

Parameters:

ctx - Current context

C_BankStatementLoader_ID - loader to use

fileName - input file

trxName - transaction

MBankStatementLoader

public MBankStatementLoader(Ctx ctx,
                            ResultSet rs,
                            String trxName)

Create a Statement Loader

Parameters:

ctx - Current context

rs - ResultSet

trxName - transaction

Method Detail

toString

public String toString()

Return Name

Overrides:

toString in class X_C_BankStatementLoader

Returns:

Name

getLocalFileName

public String getLocalFileName()

Return Local File Name

Returns:

Name

loadLines

public boolean loadLines()

Start loading Bankstatements

Returns:

true if loading completed succesfully

saveLine

public boolean saveLine()

Load a bank statement into the I_BankStatement table

Returns:

Statement line was loaded succesfully This method is called by the BankStatementLoadere whenever a complete statement line has been read.

getErrorMessage

public String getErrorMessage()

Return the most recent error

Returns:

Error message This error message will be handled as a Compiere message, (e.g. it can be translated)

getErrorDescription

public String getErrorDescription()

Return the most recent error description

Returns:

Error discription This is an additional error description, it can be used to provided descriptive iformation, such as a file name or SQL error, that can not be translated by the Compiere message system.

getLoadCount

public int getLoadCount()

The total number of statement lines loaded

Returns:

Number of imported statement lines