Package org.compiere.util

Interface PaymentExport

All Known Implementing Classes:

GenericPaymentExport

public interface PaymentExport

Custom Payment Export Interface

Version:

PaymentExport.java

Author:

Carlos Ruiz - GlobalQSS Contributors: Markus Bozem - IDEMPIERE-1546 / IDEMPIERE-3286

Method Summary

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

Method Details

exportToFile

default int exportToFile(MPaySelectionCheck[] checks,
 File file,
 StringBuffer err)

Export to File

Parameters:

checks - array of checks

file - file to export checks

Returns:

number of lines

This method is preserved for backward compatibility (old non-OSGi way via fragment), new interfaces can leave this method unimplemented and must implement the other methods

exportToFile

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

Export to file

Parameters:

checks - array of checks

depositBatch - create deposit batch

file - file to export checks

paymentRule -

err -

Returns:

number of lines

getFilenamePrefix

default String getFilenamePrefix()

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

Returns:

prefix for filename

getFilenameSuffix

default String getFilenameSuffix()

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

Returns:

suffix for filename

getContentType

default String getContentType()

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

Returns:

content type delivered to browser

supportsDepositBatch

default boolean supportsDepositBatch()

Plugin supports deposit batch

Returns:

true if supported

supportsSeparateBooking

default boolean supportsSeparateBooking()

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

Returns:

true if supported

getDefaultDepositBatch

default boolean getDefaultDepositBatch()

Default if supportsDepositBatch is true and supportsSeparateBooking is true

Returns:

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