org.hibernate.search.engine.common.EntityReference Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-search-engine Show documentation

Hibernate Search engine, always required

There is a newer version: 8.0.0.Alpha2

Show newest version

/*
 * Hibernate Search, full-text search for your domain model
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.search.engine.common;

/**
 * A reference to an indexed or contained entity.
 */
public interface EntityReference {

	/**
	 * @return The type of the referenced entity.
	 */
	Class type();

	/**
	 * @return The name of the referenced entity.
	 */
	String name();

	/**
	 * @return The identifier of the referenced entity for Hibernate Search.
	 * This is the value of the property used to generate the document ID,
	 * which is generally also the entity ID (though depending on the mapping this may be another unique property).
	 */
	Object id();

}