jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/context/orm/OrmAssociationOverrideRelationshipReference.java

/*******************************************************************************
 *  Copyright (c) 2009  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.AssociationOverrideRelationshipReference;
import org.eclipse.jpt.core.context.JoinColumnJoiningStrategy;
import org.eclipse.jpt.core.context.RelationshipMapping;
import org.eclipse.jpt.core.context.RelationshipReference;
import org.eclipse.jpt.core.context.XmlContextNode;
import org.eclipse.jpt.core.resource.orm.XmlAssociationOverride;

/**
 * An <code>AssociationOverrideRelationshipReference</code> is a type of 
 * {@link RelationshipReference} that may utilize a {@link JoinColumnJoiningStrategy}.
 * This cannot be an OrmRelationshipReference because referenced mapping comes
 * from another class, the class of the attribute that the association override
 * points to by name.
 * <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.
 * 
 * @see RelationshipMapping
 */
public interface OrmAssociationOverrideRelationshipReference 
	extends AssociationOverrideRelationshipReference, XmlContextNode
{
	OrmAssociationOverride getAssociationOverride();

	OrmJoinColumnInAssociationOverrideJoiningStrategy getJoinColumnJoiningStrategy();
	
	void update(XmlAssociationOverride xao) ;
	
}