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

import java.util.List;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jpt.core.context.persistence.PersistenceXml;
import org.eclipse.wst.validation.internal.provisional.core.IMessage;
import org.eclipse.wst.validation.internal.provisional.core.IReporter;

/**
 * Root of the Dali context model.
 * <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 JpaRootContextNode
	extends JpaContextNode
{

	// ********** persistence.xml **********

	/**
	 * String constant associated with changes to the persistence XML property
	 * @see #addPropertyChangeListener(String, org.eclipse.jpt.utility.model.listener.PropertyChangeListener)
	 */
	public final static String PERSISTENCE_XML_PROPERTY = "persistenceXml"; //$NON-NLS-1$

	/** 
	 * Return the content represented by the <code>persistence.xml</code>
	 * file associated with the root context node's JPA project.
	 * This may be null. 
	 */
	PersistenceXml getPersistenceXml();


	// ********** updating **********

	/**
	 * Update the context model with the content of the JPA resource model.
	 */
	void update(IProgressMonitor monitor);


	// ********** validation **********

	/**
	 * Add validation messages to the specified list.
	 */
	public void validate(List<IMessage> messages, IReporter reporter);

}