/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2011, 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.metamodel.binding;

import org.hibernate.FetchMode;
import org.hibernate.engine.FetchStyle;
import org.hibernate.engine.FetchTiming;
import org.hibernate.engine.spi.CascadeStyle;

/**
 * Contract describing a binding for attributes which model associations.
 *
 * @author Steve Ebersole
 */
public interface AssociationAttributeBinding extends AttributeBinding {
	/**
	 * Obtain the cascade style in effect for this association.
	 *
	 * @return The (potentially aggregated) cascade style.
	 */
	public CascadeStyle getCascadeStyle();

	/**
	 * Set the cascade styles in effect for this association.
	 *
	 * @param cascadeStyles The cascade styles.
	 */
	public void setCascadeStyles(Iterable<CascadeStyle> cascadeStyles);

	public FetchTiming getFetchTiming();
	public void setFetchTiming(FetchTiming fetchTiming);

	public FetchStyle getFetchStyle();
	public void setFetchStyle(FetchStyle fetchStyle);


	/**
	 * Temporary.  Needed for integration with legacy {@link org.hibernate.mapping} configuration of persisters.
	 *
	 * @deprecated
	 */
	@Deprecated
	@SuppressWarnings( {"JavaDoc"})
	public FetchMode getFetchMode();
}