/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2012, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.result;

Common contract for individual return objects which can be either results (ResultSetOutput) or update counts (UpdateCountOutput). 
Author:
Steve Ebersole/**
 * Common contract for individual return objects which can be either results ({@link ResultSetOutput}) or update
 * counts ({@link UpdateCountOutput}).
 *
 * @author Steve Ebersole
 */
public interface Output {
	
Determine if this return is a result (castable to ResultSetOutput). The alternative is that it is an update count (castable to UpdateCountOutput). 
Returns:
true indicates that this can be safely cast to ResultSetOutput), other wise it can be cast to UpdateCountOutput./**
	 * Determine if this return is a result (castable to {@link ResultSetOutput}).  The alternative is that it is
	 * an update count (castable to {@link UpdateCountOutput}).
	 *
	 * @return {@code true} indicates that {@code this} can be safely cast to {@link ResultSetOutput}), other wise
	 * it can be cast to {@link UpdateCountOutput}.
	 */
	public boolean isResultSet();
}