org.eclipse.uml2.uml.DeploymentTarget Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2005, 2007 IBM Corporation and others.
 * 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:
 *   IBM - initial API and implementation
 *
 * $Id: DeploymentTarget.java,v 1.9 2007/10/23 15:54:22 jbruck Exp $
 */
package org.eclipse.uml2.uml;

import org.eclipse.emf.common.util.EList;

import org.eclipse.emf.ecore.EClass;

/**
 * 
 * A representation of the model object 'Deployment Target'.
 * 
 *
 * 
 * A deployment target is the location for a deployed artifact.
 * 
 *
 * 
 * The following features are supported:
 * 

 *   {@link org.eclipse.uml2.uml.DeploymentTarget#getDeployments Deployment}
 *   {@link org.eclipse.uml2.uml.DeploymentTarget#getDeployedElements Deployed Element}
 * 
 * 
 *
 * @see org.eclipse.uml2.uml.UMLPackage#getDeploymentTarget()
 * @model abstract="true"
 * @generated
 */
public interface DeploymentTarget
		extends NamedElement {

	/**
	 * Returns the value of the 'Deployment' containment reference list.
	 * The list contents are of type {@link org.eclipse.uml2.uml.Deployment}.
	 * It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.Deployment#getLocation Location}'.
	 * 
	 * This feature subsets the following features:
	 * 

	 *   '{@link org.eclipse.uml2.uml.Element#getOwnedElements() Owned Element}'
	 *   '{@link org.eclipse.uml2.uml.NamedElement#getClientDependencies() Client Dependency}'
	 * 
	 * 
	 * 
	 * 
	 * 
	 * The set of Deployments for a DeploymentTarget.
	 * 
	 * @return the value of the 'Deployment' containment reference list.
	 * @see org.eclipse.uml2.uml.UMLPackage#getDeploymentTarget_Deployment()
	 * @see org.eclipse.uml2.uml.Deployment#getLocation
	 * @model opposite="location" containment="true" resolveProxies="true" ordered="false"
	 * @generated
	 */
	EList getDeployments();

	/**
	 * Creates a new {@link org.eclipse.uml2.uml.Deployment}, with the specified 'Name', and appends it to the 'Deployment' containment reference list.
	 * 
	 * 
	 * @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Deployment}, or null.
	 * @return The new {@link org.eclipse.uml2.uml.Deployment}.
	 * @see #getDeployments()
	 * @generated
	 */
	Deployment createDeployment(String name);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.Deployment} with the specified 'Name' from the 'Deployment' containment reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.Deployment} to retrieve, or null.
	 * @return The first {@link org.eclipse.uml2.uml.Deployment} with the specified 'Name', or null.
	 * @see #getDeployments()
	 * @generated
	 */
	Deployment getDeployment(String name);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.Deployment} with the specified 'Name' from the 'Deployment' containment reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.Deployment} to retrieve, or null.
	 * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
	 * @param createOnDemand Whether to create a {@link org.eclipse.uml2.uml.Deployment} on demand if not found.
	 * @return The first {@link org.eclipse.uml2.uml.Deployment} with the specified 'Name', or null.
	 * @see #getDeployments()
	 * @generated
	 */
	Deployment getDeployment(String name, boolean ignoreCase,
			boolean createOnDemand);

	/**
	 * Returns the value of the 'Deployed Element' reference list.
	 * The list contents are of type {@link org.eclipse.uml2.uml.PackageableElement}.
	 * 
	 * 
	 * 
	 * The set of elements that are manifested in an Artifact that is involved in Deployment to a DeploymentTarget.
	 * 
	 * @return the value of the 'Deployed Element' reference list.
	 * @see org.eclipse.uml2.uml.UMLPackage#getDeploymentTarget_DeployedElement()
	 * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false"
	 * @generated
	 */
	EList getDeployedElements();

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.PackageableElement} with the specified 'Name' from the 'Deployed Element' reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.PackageableElement} to retrieve, or null.
	 * @return The first {@link org.eclipse.uml2.uml.PackageableElement} with the specified 'Name', or null.
	 * @see #getDeployedElements()
	 * @generated
	 */
	PackageableElement getDeployedElement(String name);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.PackageableElement} with the specified 'Name' from the 'Deployed Element' reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.PackageableElement} to retrieve, or null.
	 * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
	 * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.PackageableElement} to retrieve, or null.
	 * @return The first {@link org.eclipse.uml2.uml.PackageableElement} with the specified 'Name', or null.
	 * @see #getDeployedElements()
	 * @generated
	 */
	PackageableElement getDeployedElement(String name, boolean ignoreCase,
			EClass eClass);

} // DeploymentTarget