is.codion.common.db.operation.DatabaseFunction Maven / Gradle / Ivy

Go to download
/*
 * This file is part of Codion.
 *
 * Codion is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Codion 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 Codion.  If not, see .
 *
 * Copyright (c) 2019 - 2024, Björn Darri Sigurðsson.
 */
package is.codion.common.db.operation;

/**
 * A database function
 * @param  the connection type required by this function
 * @param  the argument type
 * @param  the return type
 */
public interface DatabaseFunction {

	/**
	 * Executes this function using the given connection
	 * @param connection the connection to use
	 * @param argument the function argument, if any
	 * @return the function return argument
	 */
	R execute(C connection, T argument);
}