/*******************************************************************************
 * Copyright (c) 2010 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0, which accompanies this distribution
 * and is available at http://www.eclipse.org/legal/epl-v10.html.
 * 
 * Contributors:
 *     Oracle - initial API and implementation
 ******************************************************************************/
package org.eclipse.jpt.jpa.core.jpa2.context;

/**
 * JPA 2.0 attribute mapping
 * <p>
 * Provisional API: This interface is part of an interim API that is still
 * under development and expected to change significantly before reaching
 * stability. It is available at this early stage to solicit feedback from
 * pioneering adopters on the understanding that any code that uses this API
 * will almost certainly be broken (repeatedly) as the API evolves.
 */
public interface MappedByRelationshipMapping2_0
	extends AttributeMapping2_0
{
	/**
	 * Return whether the ID (or embedded ID) mapping is mapped by a
	 * relationship; i.e. a relationship maps the ID using the
	 * <code>@MapsId</code> annotation.
	 * <p>
	 * <strong>NB:</strong> There can be several relationships
	 * (erroneously, of course).
	 */
	boolean isMappedByRelationship();

	/**
	 * Property string associated with changes to the mapped by relationship
	 */
	final String MAPPED_BY_RELATIONSHIP_PROPERTY = "mappedByRelationship"; //$NON-NLS-1$
}