Package: ECPCheckoutSource

ECPCheckoutSource

Coverage

1: /*******************************************************************************
2: * Copyright (c) 2011-2012 EclipseSource Muenchen GmbH and others.
3: *
4: * All rights reserved. This program and the accompanying materials
5: * are made available under the terms of the Eclipse Public License 2.0
6: * which accompanies this distribution, and is available at
7: * https://www.eclipse.org/legal/epl-2.0/
8: *
9: * SPDX-License-Identifier: EPL-2.0
10: *
11: * Contributors:
12: * Eike Stepper - initial API and implementation
13: * Eugen Neufeld - JavaDoc
14: *
15: *******************************************************************************/
16:
17: package org.eclipse.emf.ecp.core.util;
18:
19: import org.eclipse.emf.ecp.core.exceptions.ECPProjectWithNameExistsException;
20:
21: /**
22: * This class describes an object that can be checked out.
23: *
24: * @author Eike Stepper
25: * @author Eugen Neufeld
26: */
27: public interface ECPCheckoutSource extends ECPRepositoryAware {
28:         /**
29:          * This return the default name for a project that was checked out.
30:          *
31:          * @return the default name
32:          */
33:         String getDefaultCheckoutName();
34:
35:         /**
36:          * This method is called in order execute the checkout.
37:          *
38:          * @param projectName the name of the project to create
39:          * @param projectProperties the {@link ECPProperties} to use
40:          * @throws ECPProjectWithNameExistsException is thrown when a project with such a name already exists
41:          */
42:
43:         void checkout(String projectName, ECPProperties projectProperties) throws ECPProjectWithNameExistsException;
44: }