old/org.eclipse.emf.ecp.common.model/src/org/eclipse/emf/ecp/common/model/workSpaceModel/ECPProject.java

/*******************************************************************************
 * Copyright (c) 2008-2011 Chair for Applied Software Engineering,
 * Technische Universitaet Muenchen.
 * 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:
 ******************************************************************************/
package org.eclipse.emf.ecp.common.model.workSpaceModel;

import java.util.Collection;

import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecp.common.model.ECPModelelementContext;

/**
 * <!-- begin-user-doc --> A representation of the model object ' <em><b>ECP Project</b></em>'.
 * 
 * @implements ECPModelelementContext <!-- end-user-doc -->
 * 
 *             <p>
 *             The following features are supported:
 *             <ul>
 *             <li>{@link org.eclipse.emf.ecp.common.model.workSpaceModel.ECPProject#getWorkspace <em>Workspace</em>}</li>
 *             <li>{@link org.eclipse.emf.ecp.common.model.workSpaceModel.ECPProject#getRootObject <em>Root Object</em>}
 *             </li>
 *             </ul>
 *             </p>
 * 
 * @see org.eclipse.emf.ecp.common.model.workSpaceModel.WorkSpaceModelPackage#getECPProject()
 * @model abstract="true"
 * @generated
 */
public interface ECPProject extends EObject, ECPModelelementContext {

	/**
	 * Returns the value of the '<em><b>Workspace</b></em>' container reference.
	 * It is bidirectional and its opposite is '
	 * {@link org.eclipse.emf.ecp.common.model.workSpaceModel.ECPWorkspace#getProjects <em>Projects</em>}'.
	 * <!-- begin-user-doc
	 * -->
	 * <p>
	 * If the meaning of the '<em>Workspace</em>' container reference isn't clear, there really should be more of a
	 * description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * 
	 * @return the value of the '<em>Workspace</em>' container reference.
	 * @see #setWorkspace(ECPWorkspace)
	 * @see org.eclipse.emf.ecp.common.model.workSpaceModel.WorkSpaceModelPackage#getECPProject_Workspace()
	 * @see org.eclipse.emf.ecp.common.model.workSpaceModel.ECPWorkspace#getProjects
	 * @model opposite="projects" transient="false"
	 * @generated
	 */
	ECPWorkspace getWorkspace();

	/**
	 * Sets the value of the '{@link org.eclipse.emf.ecp.common.model.workSpaceModel.ECPProject#getWorkspace
	 * <em>Workspace</em>}' container reference.
	 * <!-- begin-user-doc --> <!-- end-user-doc -->
	 * 
	 * @param value the new value of the '<em>Workspace</em>' container reference.
	 * @see #getWorkspace()
	 * @generated
	 */
	void setWorkspace(ECPWorkspace value);

	/**
	 * Checks whether an EObject is contained in the project.
	 * 
	 * @param eObject EObject
	 * @return true if is contained
	 * @generated not
	 */
	boolean contains(EObject eObject);

	/**
	 * Returns all model elements contained in the project. Don't add elements to this collection. Instead use
	 * {@link #addModelElementToRoot(EObject)} or attach it as a child of an element of this collection.
	 * 
	 * @return all model elements
	 * @generated not
	 */
	Collection<EObject> getAllModelElements();

	void dispose();

	/**
	 * Allows to add an {@link ECPProjectListener}.
	 * 
	 * @param listener listener
	 * @generated not
	 */
	void addECPProjectListener(ECPProjectListener listener);

	/**
	 * Allows to remove an {@link ECPProjectListener}.
	 * 
	 * @param listener listener
	 * @generated not
	 */
	void removeECPProjectListener(ECPProjectListener listener);

	/**
	 * Notifies listeners about changes in the project.
	 * 
	 * @generated not
	 */
	void projectChanged();

	/**
	 * Notifies about deletion of a project.
	 * 
	 * @generated not
	 */
	void projectDeleted();

	/**
	 * Notifies about deletion of an model element.
	 * 
	 * @param eobject
	 */
	void modelelementDeleted(EObject eobject);

	/**
	 * Lets you add an element to the RootObject. This method is necessary since you don't know which feature of the
	 * RootObject to use.
	 * 
	 * @param eObject
	 * @generated not
	 */
	void addModelElementToRoot(EObject eObject);

	/**
	 * Returns the root object of the model, which is visible to the user. In general it is some sort of project.
	 * 
	 * @return eobject
	 */
	EObject getRootObject();

	/**
	 * Returns the root container of all EObjects contained in the project. This can but does not need to be identical
	 * with the root object return by getRootObject().
	 * 
	 * @return
	 */
	EObject getRootContainer();

	/**
	 * Sets the value of the '{@link org.eclipse.emf.ecp.common.model.workSpaceModel.ECPProject#getRootObject
	 * <em>Root Object</em>}' reference.
	 * <!-- begin-user-doc --> <!-- end-user-doc -->
	 * 
	 * @param value the new value of the '<em>Root Object</em>' reference.
	 * @see #getRootObject()
	 * @generated
	 */
	void setRootObject(EObject value);

} // ECPProject