/*
 * 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.persister.walking.spi;

Describes aspects of the identifier for an entity
Author:
Steve Ebersole/**
 * Describes aspects of the identifier for an entity
 *
 * @author Steve Ebersole
 */
public interface EntityIdentifierDefinition {
	
Is the entity identifier encapsulated?  Meaning, is it represented by a single attribute?
Returns:
true indicates the identifier is encapsulated (and therefore this is castable to EncapsulatedEntityIdentifierDefinition); false means it is not encapsulated (and therefore castable to NonEncapsulatedEntityIdentifierDefinition)./**
	 * Is the entity identifier encapsulated?  Meaning, is it represented by a single attribute?
	 *
	 * @return {@code true} indicates the identifier is encapsulated (and therefore this is castable to
	 * {@link EncapsulatedEntityIdentifierDefinition}); {@code false} means it is not encapsulated (and therefore
	 * castable to {@link NonEncapsulatedEntityIdentifierDefinition}).
	 *
	 */
	public boolean isEncapsulated();

	public EntityDefinition getEntityDefinition();
}