/******************************************************************************
 * Product: Adempiere ERP & CRM Smart Business Solution                       *
 * Copyright (C) 1999-2006 ComPiere, Inc. All Rights Reserved.                *
 * This program is free software; you can redistribute it and/or modify it    *
 * under the terms version 2 of the GNU General Public License as published   *
 * by the Free Software Foundation. This program is distributed in the hope   *
 * that it will be useful, but WITHOUT ANY WARRANTY; without even the implied *
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.           *
 * See the GNU General Public License for more details.                       *
 * You should have received a copy of the GNU General Public License along    *
 * with this program; if not, write to the Free Software Foundation, Inc.,    *
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.                     *
 * For the text or an alternative of this public license, you may reach us    *
 * ComPiere, Inc., 2620 Augustine Dr. #245, Santa Clara, CA 95054, USA        *
 * or via info@compiere.org or http://www.compiere.org/license.html           *
 *****************************************************************************/
package org.compiere.util;

import java.io.File;

import org.compiere.model.MPaySelectionCheck;

/**
 * 	Custom Payment Export Interface
 *	
 *  @author Carlos Ruiz - GlobalQSS
 *
 *  Contributors:
 *    Markus Bozem - IDEMPIERE-1546 / IDEMPIERE-3286
 *
 *  @version PaymentExport.java
 */
public interface PaymentExport
{
	/**
	 *  Export to File
	 *  @param checks array of checks
	 *  @param file file to export checks
	 *  @return number of lines
	 *  <p>
	 *  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
	 */
	public default int exportToFile (MPaySelectionCheck[] checks, File file, StringBuffer err) {
		return exportToFile (checks, false, (String)null, file, err);
	}

	/**
	 *  Export to file
	 *  @param checks array of checks
	 *  @param depositBatch create deposit batch 
	 *  @param file file to export checks
	 *  @param paymentRule
	 *  @param err
	 *  @return number of lines
	 */
	public default int exportToFile (MPaySelectionCheck[] checks, boolean depositBatch, String paymentRule, File file, StringBuffer err) {
		return exportToFile (checks, file, err);
	}

	/**
	 * Get the filename prefix from plugin
	 * e.g. "SEPA-Credit-Transfer-"
	 * @return prefix for filename 
	 */
	public default String getFilenamePrefix() {
		return "paymentExport";
	}

	/**
	 * Get the filename suffix from plugin
	 * e.g. ".xml" 
	 * @return suffix for filename
	 */
	public default String getFilenameSuffix() {
		return ".txt";
	}

	/**
	 * Get the content type from plugin
	 * e.g. "text/xml" or "text/csv"
	 * @return content type delivered to browser
	 */
	public default String getContentType() {
		return "text/plain";
	}

	/**
	 * Plugin supports deposit batch 
	 * @return true if supported
	 */
	public default boolean supportsDepositBatch() {
		return false;
	}

	/**
	 * Plugin supports booking payments separate on bank statement (no deposit batch)
	 * @return true if supported
	 */
	public default boolean supportsSeparateBooking() {
		return false;
	}

	/**
	 * Default if supportsDepositBatch is true and supportsSeparateBooking is true
	 * @return true if deposit batch should be selected on default, false if deposit batch should not be selected
	 */
	public default boolean getDefaultDepositBatch() {
		return false;
	}

}	//	PaymentExport
