/*******************************************************************************
 *  Copyright (c) 2009, 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.core.context.orm;

import org.eclipse.jpt.core.context.RelationshipReference;
import org.eclipse.jpt.core.context.XmlContextNode;

/**
 * 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.
 * 
 * @version 2.3
 * @since 2.2
 */
public interface OrmRelationshipReference
	extends XmlContextNode, RelationshipReference
{
	OrmRelationshipMapping getRelationshipMapping();
	
	OrmJoiningStrategy getPredominantJoiningStrategy();

	void update();

	void initializeOn(OrmRelationshipReference newRelationshipReference);
	
	void initializeFromOwnableRelationshipReference(
		OrmOwnableRelationshipReference oldRelationshipReference);
	
	void initializeFromJoinColumnEnabledRelationshipReference(
		OrmJoinColumnEnabledRelationshipReference oldRelationshipReference);
	
	void initializeFromJoinTableEnabledRelationshipReference(
		OrmJoinTableEnabledRelationshipReference oldRelationshipReference);
}