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

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

import org.eclipse.jpt.jpa.core.context.DiscriminatorColumn;
import org.eclipse.jpt.jpa.core.resource.orm.XmlDiscriminatorColumn;

/**
 * <code>orm.xml</code> discriminator column
 * <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.2
 * @since 2.0
 */
public interface OrmDiscriminatorColumn
	extends DiscriminatorColumn, OrmNamedColumn
{
	XmlDiscriminatorColumn getXmlColumn();
	

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

	/**
	 * interface allowing discriminator columns to be used in multiple places
	 */
	interface Owner
		extends OrmNamedColumn.Owner, DiscriminatorColumn.Owner
	{
		XmlDiscriminatorColumn getXmlColumn();
		
		XmlDiscriminatorColumn buildXmlColumn();
		
		void removeXmlColumn();
	}
}