blob: ab27a561f3dd8db1e6259091edd096d9fbe65eb8 [file] [log] [blame]
/*
* Copyright (c) 2003, 2006 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: Artifact.java,v 1.12 2006/05/26 18:16:52 khussey Exp $
*/
package org.eclipse.uml2;
import java.util.Set;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EClass;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Artifact</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.uml2.Artifact#getFileName <em>File Name</em>}</li>
* <li>{@link org.eclipse.uml2.Artifact#getNestedArtifacts <em>Nested Artifact</em>}</li>
* <li>{@link org.eclipse.uml2.Artifact#getManifestations <em>Manifestation</em>}</li>
* <li>{@link org.eclipse.uml2.Artifact#getOwnedOperations <em>Owned Operation</em>}</li>
* <li>{@link org.eclipse.uml2.Artifact#getOwnedAttributes <em>Owned Attribute</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.uml2.UML2Package#getArtifact()
* @model
* @generated
*/
public interface Artifact extends Classifier, DeployedArtifact {
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
String copyright = "Copyright (c) IBM Corporation and others."; //$NON-NLS-1$
/**
* Returns the value of the '<em><b>File Name</b></em>' attribute.
* The default value is <code>""</code>.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>File Name</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>File Name</em>' attribute.
* @see #setFileName(String)
* @see org.eclipse.uml2.UML2Package#getArtifact_FileName()
* @model default="" dataType="org.eclipse.uml2.String"
* @generated
*/
String getFileName();
/**
* Sets the value of the '{@link org.eclipse.uml2.Artifact#getFileName <em>File Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>File Name</em>' attribute.
* @see #getFileName()
* @generated
*/
void setFileName(String value);
/**
* Returns the value of the '<em><b>Nested Artifact</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.Artifact}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Nested Artifact</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Nested Artifact</em>' containment reference list.
* @see org.eclipse.uml2.UML2Package#getArtifact_NestedArtifact()
* @model type="org.eclipse.uml2.Artifact" containment="true" ordered="false"
* @generated
*/
EList getNestedArtifacts();
/**
* Retrieves the first {@link org.eclipse.uml2.Artifact} with the specified '<em><b>Name</b></em>' from the '<em><b>Nested Artifact</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.Artifact} to retrieve, or <code>null</code>.
* @return The first {@link org.eclipse.uml2.Artifact} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getNestedArtifacts()
* @generated
*/
Artifact getNestedArtifact(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.Artifact} with the specified '<em><b>Name</b></em>' from the '<em><b>Nested Artifact</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.Artifact} to retrieve, or <code>null</code>.
* @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
* @param eClass The Ecore class of the {@link org.eclipse.uml2.Artifact} to retrieve, or <code>null</code>.
* @return The first {@link org.eclipse.uml2.Artifact} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getNestedArtifacts()
* @generated
*/
Artifact getNestedArtifact(String name, boolean ignoreCase, EClass eClass);
/**
* Creates a {@link org.eclipse.uml2.Artifact} and appends it to the '<em><b>Nested Artifact</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param eClass The Ecore class of the {@link org.eclipse.uml2.Artifact} to create.
* @return The new {@link org.eclipse.uml2.Artifact}.
* @see #getNestedArtifacts()
* @generated NOT
*/
Artifact createNestedArtifact(EClass eClass);
/**
* Creates a {@link org.eclipse.uml2.Artifact} and appends it to the '<em><b>Nested Artifact</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return The new {@link org.eclipse.uml2.Artifact}.
* @see #getNestedArtifacts()
* @generated NOT
*/
Artifact createNestedArtifact();
/**
* Returns the value of the '<em><b>Manifestation</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.Manifestation}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Manifestation</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Manifestation</em>' containment reference list.
* @see org.eclipse.uml2.UML2Package#getArtifact_Manifestation()
* @model type="org.eclipse.uml2.Manifestation" containment="true" ordered="false"
* @generated
*/
EList getManifestations();
/**
* Retrieves the first {@link org.eclipse.uml2.Manifestation} with the specified '<em><b>Name</b></em>' from the '<em><b>Manifestation</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.Manifestation} to retrieve, or <code>null</code>.
* @return The first {@link org.eclipse.uml2.Manifestation} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getManifestations()
* @generated
*/
Manifestation getManifestation(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.Manifestation} with the specified '<em><b>Name</b></em>' from the '<em><b>Manifestation</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.Manifestation} to retrieve, or <code>null</code>.
* @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
* @return The first {@link org.eclipse.uml2.Manifestation} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getManifestations()
* @generated
*/
Manifestation getManifestation(String name, boolean ignoreCase);
/**
* Creates a {@link org.eclipse.uml2.Manifestation} and appends it to the '<em><b>Manifestation</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param eClass The Ecore class of the {@link org.eclipse.uml2.Manifestation} to create.
* @return The new {@link org.eclipse.uml2.Manifestation}.
* @see #getManifestations()
* @generated NOT
* @deprecated Use #createManifestation() instead.
*/
Manifestation createManifestation(EClass eClass);
/**
* Creates a {@link org.eclipse.uml2.Manifestation} and appends it to the '<em><b>Manifestation</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return The new {@link org.eclipse.uml2.Manifestation}.
* @see #getManifestations()
* @generated NOT
*/
Manifestation createManifestation();
/**
* Returns the value of the '<em><b>Owned Operation</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.Operation}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return the value of the '<em>Owned Operation</em>' containment reference list.
* @see org.eclipse.uml2.UML2Package#getArtifact_OwnedOperation()
* @model type="org.eclipse.uml2.Operation" containment="true"
* @generated
*/
EList getOwnedOperations();
/**
* Retrieves the first {@link org.eclipse.uml2.Operation} with the specified '<em><b>Name</b></em>' from the '<em><b>Owned Operation</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.Operation} to retrieve, or <code>null</code>.
* @return The first {@link org.eclipse.uml2.Operation} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getOwnedOperations()
* @generated
*/
Operation getOwnedOperation(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.Operation} with the specified '<em><b>Name</b></em>' from the '<em><b>Owned Operation</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.Operation} to retrieve, or <code>null</code>.
* @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
* @return The first {@link org.eclipse.uml2.Operation} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getOwnedOperations()
* @generated
*/
Operation getOwnedOperation(String name, boolean ignoreCase);
/**
* Creates a {@link org.eclipse.uml2.Operation} and appends it to the '<em><b>Owned Operation</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param eClass The Ecore class of the {@link org.eclipse.uml2.Operation} to create.
* @return The new {@link org.eclipse.uml2.Operation}.
* @see #getOwnedOperations()
* @generated NOT
* @deprecated Use #createOwnedOperation() instead.
*/
Operation createOwnedOperation(EClass eClass);
/**
* Creates a {@link org.eclipse.uml2.Operation} and appends it to the '<em><b>Owned Operation</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return The new {@link org.eclipse.uml2.Operation}.
* @see #getOwnedOperations()
* @generated NOT
*/
Operation createOwnedOperation();
/**
* Returns the value of the '<em><b>Owned Attribute</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.Property}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return the value of the '<em>Owned Attribute</em>' containment reference list.
* @see org.eclipse.uml2.UML2Package#getArtifact_OwnedAttribute()
* @model type="org.eclipse.uml2.Property" containment="true"
* @generated
*/
EList getOwnedAttributes();
/**
* Retrieves the first {@link org.eclipse.uml2.Property} with the specified '<em><b>Name</b></em>' from the '<em><b>Owned Attribute</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.Property} to retrieve, or <code>null</code>.
* @return The first {@link org.eclipse.uml2.Property} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getOwnedAttributes()
* @generated
*/
Property getOwnedAttribute(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.Property} with the specified '<em><b>Name</b></em>' from the '<em><b>Owned Attribute</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.Property} to retrieve, or <code>null</code>.
* @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
* @param eClass The Ecore class of the {@link org.eclipse.uml2.Property} to retrieve, or <code>null</code>.
* @return The first {@link org.eclipse.uml2.Property} with the specified '<em><b>Name</b></em>', or <code>null</code>.
* @see #getOwnedAttributes()
* @generated
*/
Property getOwnedAttribute(String name, boolean ignoreCase, EClass eClass);
/**
* Creates a {@link org.eclipse.uml2.Property} and appends it to the '<em><b>Owned Attribute</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param eClass The Ecore class of the {@link org.eclipse.uml2.Property} to create.
* @return The new {@link org.eclipse.uml2.Property}.
* @see #getOwnedAttributes()
* @generated NOT
*/
Property createOwnedAttribute(EClass eClass);
/**
* Creates a {@link org.eclipse.uml2.Property} and appends it to the '<em><b>Owned Attribute</b></em>' containment reference list.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return The new {@link org.eclipse.uml2.Property}.
* @see #getOwnedAttributes()
* @generated NOT
*/
Property createOwnedAttribute();
// <!-- begin-custom-operations -->
/**
* Retrieves all the (inherited and owned) operations of this artifact.
*
* @return The inherited and owned operations of this artifact.
*/
Set getAllOperations();
// <!-- end-custom-operations -->
} // Artifact