jpa/plugins/org.eclipse.jpt.jpa.core/src/org/eclipse/jpt/jpa/core/context/java/JavaAssociationOverrideContainer.java

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

import java.util.ListIterator;
import org.eclipse.jpt.jpa.core.context.AssociationOverrideContainer;
import org.eclipse.jpt.jpa.core.context.Override_;
import org.eclipse.jpt.jpa.core.context.ReadOnlyOverrideRelationship;
import org.eclipse.jpt.jpa.core.context.VirtualOverride;

/**
 * Java association override container
 * <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.
 * 
 * @version 2.3
 * @since 2.3
 */
public interface JavaAssociationOverrideContainer
	extends AssociationOverrideContainer, JavaOverrideContainer
{
	/**
	 * Return the specified override's relationship.
	 * This is used by the <code>orm.xml</code> association override container
	 * when it is also using the Java container's override names.
	 * @see #getOverrideNames()
	 */
	ReadOnlyOverrideRelationship getOverrideRelationship(String overrideName);

	// covariant overrides
	ListIterator<JavaReadOnlyAssociationOverride> overrides();
	JavaReadOnlyAssociationOverride getOverrideNamed(String name);
	ListIterator<JavaAssociationOverride> specifiedOverrides();
	JavaAssociationOverride getSpecifiedOverride(int index);
	JavaAssociationOverride getSpecifiedOverrideNamed(String name);
	ListIterator<JavaVirtualAssociationOverride> virtualOverrides();
	JavaVirtualAssociationOverride convertOverrideToVirtual(Override_ specifiedOverride);
	JavaAssociationOverride convertOverrideToSpecified(VirtualOverride virtualOverride);


	// ********** owner **********

	interface Owner
		extends AssociationOverrideContainer.Owner, JavaOverrideContainer.Owner
	{		
		// combine interfaces
	}
}