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

import org.eclipse.jpt.core.TextRange;
import org.eclipse.jpt.core.context.AccessType;
import org.eclipse.jpt.core.context.TypeMapping;
import org.eclipse.jpt.core.context.java.JavaPersistentType;
import org.eclipse.jpt.core.resource.orm.AbstractTypeMapping;
import org.eclipse.jpt.core.resource.orm.XmlEntityMappings;

public interface OrmTypeMapping extends TypeMapping, OrmJpaContextNode
{
	String JAVA_PERSISTENT_TYPE_PROPERTY = "javaPersistentTypeProperty";

	String getClass_();
	void setClass(String newClass);
	String CLASS_PROPERTY = "classProperty";

	AccessType getAccess();
	AccessType getDefaultAccess();
	String DEFAULT_ACCESS_PROPERTY = "defaultAccessProperty";

	AccessType getSpecifiedAccess();
	void setSpecifiedAccess(AccessType newSpecifiedAccess);
	String SPECIFIED_ACCESS_PROPERTY = "specifiedAccessProperty";

	
	boolean isMetadataComplete();
	Boolean getSpecifiedMetadataComplete();
	void setSpecifiedMetadataComplete(Boolean newSpecifiedMetadataComplete);
		String SPECIFIED_METADATA_COMPLETE_PROPERTY = "specifiedMetadataCompleteProperty";

	boolean isDefaultMetadataComplete();
		String DEFAULT_METADATA_COMPLETE_PROPERTY = "defaultMetadataCompleteProperty";

	
	/**
	 * type mappings are a sequence in the orm schema. We must keep
	 * the list of type mappings in the appropriate order so the wtp xml 
	 * translators will write them to the xml in that order and they
	 * will adhere to the schema.  
	 * 
	 * Each concrete subclass of XmlTypeMapping must implement this
	 * method and return an int that matches it's order in the schema
	 * @return
	 */
	int xmlSequence();

	void removeFromResourceModel(XmlEntityMappings entityMappings);
		
	AbstractTypeMapping addToResourceModel(XmlEntityMappings entityMappings);

	void initializeFrom(OrmTypeMapping oldMapping);

	AbstractTypeMapping typeMappingResource();
	
	JavaPersistentType getJavaPersistentType();

	TextRange selectionTextRange();

	boolean containsOffset(int textOffset);
}