Package org.compiere.util

Class GenericPaymentExport

java.lang.Object

org.compiere.util.GenericPaymentExport

All Implemented Interfaces:

PaymentExport

public class GenericPaymentExport
extends Object
implements PaymentExport

Generic Payment Export Sample implementation of Payment Export Interface - brought here from MPaySelectionCheck

Author:

Jorg Janke Contributors: Carlos Ruiz - GlobalQSS - FR 3132033 - Make payment export class configurable per bank

Constructor Summary

Constructors

Constructor	Description
GenericPaymentExport()

Method Summary

Modifier and Type	Method	Description
int	exportToFile(MPaySelectionCheck[] checks, boolean depositBatch, String paymentRule, File file, StringBuffer err)	Export to File
String	getContentType()	Get the content type from plugin e.g.
boolean	getDefaultDepositBatch()	Default if supportsDepositBatch is true and supportsSeparateBooking is true
String	getFilenamePrefix()	Get the filename prefix from plugin e.g.
String	getFilenameSuffix()	Get the filename suffix from plugin e.g. ".xml"
boolean	supportsDepositBatch()	Plugin supports deposit batch
boolean	supportsSeparateBooking()	Plugin supports booking payments separate on bank statement (no deposit batch)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.compiere.util.PaymentExport

exportToFile

Constructor Detail

GenericPaymentExport

public GenericPaymentExport()

Method Detail

exportToFile

public int exportToFile(MPaySelectionCheck[] checks,
                        boolean depositBatch,
                        String paymentRule,
                        File file,
                        StringBuffer err)

Export to File

Specified by:

exportToFile in interface PaymentExport

Parameters:

checks - array of checks

depositBatch - book the payments as single position

paymentRule - selected payment rule

file - file to export checks

Returns:

number of lines

getFilenamePrefix

public String getFilenamePrefix()

Description copied from interface: PaymentExport

Get the filename prefix from plugin e.g. "SEPA-Credit-Transfer-"

Specified by:

getFilenamePrefix in interface PaymentExport

Returns:

prefix for filename

getFilenameSuffix

public String getFilenameSuffix()

Description copied from interface: PaymentExport

Get the filename suffix from plugin e.g. ".xml"

Specified by:

getFilenameSuffix in interface PaymentExport

Returns:

suffix for filename

getContentType

public String getContentType()

Description copied from interface: PaymentExport

Get the content type from plugin e.g. "text/xml" or "text/csv"

Specified by:

getContentType in interface PaymentExport

Returns:

content type delivered to browser

supportsDepositBatch

public boolean supportsDepositBatch()

Description copied from interface: PaymentExport

Plugin supports deposit batch

Specified by:

supportsDepositBatch in interface PaymentExport

Returns:

true if supported

supportsSeparateBooking

public boolean supportsSeparateBooking()

Description copied from interface: PaymentExport

Plugin supports booking payments separate on bank statement (no deposit batch)

Specified by:

supportsSeparateBooking in interface PaymentExport

Returns:

true if supported

getDefaultDepositBatch

public boolean getDefaultDepositBatch()

Description copied from interface: PaymentExport

Default if supportsDepositBatch is true and supportsSeparateBooking is true

Specified by:

getDefaultDepositBatch in interface PaymentExport

Returns:

true if deposit batch should be selected on default, false if deposit batch should not be selected