bundles/org.eclipse.vorto.common/src/org/eclipse/vorto/api/common/project/IFunctionBlockProject.java

/*******************************************************************************
 * Copyright (c) 2014 Bosch Software Innovations GmbH and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Eclipse Distribution License v1.0 which accompany this distribution.
 *
 * The Eclipse Public License is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * The Eclipse Distribution License is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 * Bosch Software Innovations GmbH - Please refer to git log
 *
 *******************************************************************************/
package org.eclipse.vorto.api.common.project;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.vorto.functionblock.FunctionblockModel;


public interface IFunctionBlockProject {
	/**
	 * The name of the m2m project
	 * 
	 * @return
	 */
	String getName();

	/**
	 * gets any file of the current project by its relative path
	 * 
	 * @param name
	 * @return
	 */
	IFile getFile(String path);

	/**
	 * refreshes the project and its content
	 * 
	 * @param monitor
	 *            callback to give feedback to the user while it is refreshing
	 * @throws CoreException
	 */
	void refresh(IProgressMonitor monitor) throws CoreException;

	/**
	 * retrieve the domain model of the project
	 * 
	 * @return FunctionBlockModel fbm
	 */
	FunctionblockModel getFunctionBlockModel();

}