/*******************************************************************************
 * 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.Iterator;
import org.eclipse.jpt.core.utility.jdt.Member;

/**
 * 
 * 
 * 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 JavaResourcePersistentType extends JavaResourcePersistentMember
{	
	/**
	 * Return only the immediately nested persistable nestedTypes
	 */
	Iterator<JavaResourcePersistentType> nestedTypes();
		String NESTED_TYPES_COLLECTION = "nestedTypes";

	/**
	 * Return only the persistable attributes, those that respond true to
	 * {@link JavaResourcePersistentAttribute#isPersistable()}
	 * This returns fields and properties
	 */
	Iterator<JavaResourcePersistentAttribute> attributes();
		String ATTRIBUTES_COLLECTION = "attributes";
	
	/**
	 * Return only the persistable fields, those that respond true to
	 * {@link JavaResourcePersistentAttribute#isPersistable()}
	 * This returns filters out all properties and only returns fields
	 */
	Iterator<JavaResourcePersistentAttribute> fields();

	/**
	 * Return only the persistable fields, those that respond true to
	 * {@link JavaResourcePersistentAttribute#isPersistable()}
	 * This returns filters out all fields and only returns properties
	 */
	Iterator<JavaResourcePersistentAttribute> properties();
	
	// TODO rename to getJavaResourcePersistentType(String)
	JavaResourcePersistentType getJavaPersistentTypeResource(String fullyQualifiedTypeName);

	/**
	 * Return the fully qualified type name
	 */
	String getQualifiedName();
		String QUALIFIED_NAME_PROPERTY = "qualifiedName";

	/**
	 * Return the fully unqualified type name
	 */
	String getName();
		String NAME_PROPERTY = "name";

	String getSuperClassQualifiedName();
		String SUPER_CLASS_QUALIFIED_NAME_PROPERTY = "superClassQualifiedName";
	
	AccessType getAccess();
		String ACCESS_PROPERTY = "access";
		
	boolean isAbstract();
		String ABSTRACT_PROPERTY = "abstract";	
		
	Member getMember();
	
	/**
	 * Return whether any attributes in this persistentType have
	 * JPA annotations on them.
	 */
	boolean hasAnyAttributeAnnotations();
}