/*******************************************************************************
 * Copyright (c) 2007, 2008 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.resource.java;

import java.util.ListIterator;

/**
 * Corresponds to the javax.persistence.AssociationOverride annotation
 * 
 * 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 AssociationOverrideAnnotation extends OverrideAnnotation
{
	String ANNOTATION_NAME = JPA.ASSOCIATION_OVERRIDE;

	
	/**
	 * Corresponds to the joinColumns element of the AssociationOverride annotation.
	 * Returns an empty iterator if the joinColumns element does not exist in java.
	 */
	ListIterator<JoinColumnAnnotation> joinColumns();
	
	JoinColumnAnnotation joinColumnAt(int index);
	
	int indexOfJoinColumn(JoinColumnAnnotation joinColumn);
	
	int joinColumnsSize();

	JoinColumnAnnotation addJoinColumn(int index);
	
	void removeJoinColumn(int index);
	
	void moveJoinColumn(int targetIndex, int sourceIndex);
	
		String JOIN_COLUMNS_LIST = "joinColumnsList";
}