/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2013, 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.loader.plan.spi;

Descriptor for the identifier of an entity as a FetchSource (which allows for key-many-to-one handling).
Author:
Steve Ebersole/**
 * Descriptor for the identifier of an entity as a FetchSource (which allows for key-many-to-one handling).
 *
 * @author Steve Ebersole
 */
public interface EntityIdentifierDescription {
	
Can this EntityIdentifierDescription be treated as a FetchSource and if so does it have any
fetches?
Returns:
true iff this can be cast to FetchSource and (after casting) it returns non-empty results for FetchSource.getFetches()/**
	 * Can this EntityIdentifierDescription be treated as a FetchSource and if so does it have any
	 * fetches?
	 *
	 * @return {@code true} iff {@code this} can be cast to {@link FetchSource} and (after casting) it returns
	 * non-empty results for {@link FetchSource#getFetches()}
	 */
	public boolean hasFetches();

	
Can this EntityIdentifierDescription be treated as a FetchSource and if so does it have any
bidirectional entity references?
Returns:
true iff this can be cast to FetchSource and (after casting) it returns non-empty results for FetchSource.getBidirectionalEntityReferences()/**
	 * Can this EntityIdentifierDescription be treated as a FetchSource and if so does it have any
	 * bidirectional entity references?
	 *
	 * @return {@code true} iff {@code this} can be cast to {@link FetchSource} and (after casting) it returns
	 * non-empty results for {@link FetchSource#getBidirectionalEntityReferences()}
	 */
	public boolean hasBidirectionalEntityReferences();
}