/*******************************************************************************
* This file is part of OpenNMS(R).
*
* Copyright (C) 2009-2011 The OpenNMS Group, Inc.
* OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
*
* OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
*
* OpenNMS(R) 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.
*
* OpenNMS(R) 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 OpenNMS(R). If not, see:
* http://www.gnu.org/licenses/
*
* For more information contact:
* OpenNMS(R) Licensing <license@opennms.org>
* http://www.opennms.org/
* http://www.opennms.com/
*******************************************************************************/
package org.opennms.web.notification.filter;
import java.sql.PreparedStatement;
import java.sql.SQLException;
/**
* Convenience class to determine what sort of notices to include in a
* query.
*
* @author ranger
* @version $Id: $
* @since 1.8.1
*/
public interface Filter {
/**
* <p>getSql</p>
*
* @return a {@link java.lang.String} object.
*/
public String getSql();
/**
* <p>getParamSql</p>
*
* @return a {@link java.lang.String} object.
*/
public String getParamSql();
/**
* <p>bindParams</p>
*
* @param ps a {@link java.sql.PreparedStatement} object.
* @param parameterIndex a int.
* @return a int.
* @throws java.sql.SQLException if any.
*/
public int bindParams(PreparedStatement ps, int parameterIndex) throws SQLException;
/**
* <p>getDescription</p>
*
* @return a {@link java.lang.String} object.
*/
public String getDescription();
/**
* <p>getTextDescription</p>
*
* @return a {@link java.lang.String} object.
*/
public String getTextDescription();
}