org.eclipse.uml2.uml.Artifact Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2005, 2014 IBM Corporation, CEA, 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
* Kenn Hussey (CEA) - 327039, 351774, 418466
* Christian W. Damus (CEA) - 251963, 269598
*
*/
package org.eclipse.uml2.uml;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EClass;
/**
*
* A representation of the model object 'Artifact'.
* @extends AttributeOwner, OperationOwner
*
*
*
* An artifact is the specification of a physical piece of information that is used or produced by a software development process, or by deployment and operation of a system. Examples of artifacts include model files, source files, scripts, and binary executable files, a table in a database system, a development deliverable, or a word-processing document, a mail message.
* An artifact is the source of a deployment to a node.
* From package UML::Deployments.
*
*
*
* The following features are supported:
*
* - {@link org.eclipse.uml2.uml.Artifact#getFileName File Name}
* - {@link org.eclipse.uml2.uml.Artifact#getManifestations Manifestation}
* - {@link org.eclipse.uml2.uml.Artifact#getNestedArtifacts Nested Artifact}
* - {@link org.eclipse.uml2.uml.Artifact#getOwnedAttributes Owned Attribute}
* - {@link org.eclipse.uml2.uml.Artifact#getOwnedOperations Owned Operation}
*
*
*
* @see org.eclipse.uml2.uml.UMLPackage#getArtifact()
* @model
* @generated
*/
public interface Artifact
extends Classifier, DeployedArtifact, AttributeOwner, OperationOwner {
/**
* Returns the value of the 'File Name' attribute.
*
*
*
* A concrete name that is used to refer to the Artifact in a physical context. Example: file system name, universal resource locator.
* From package UML::Deployments.
*
* @return the value of the 'File Name' attribute.
* @see #isSetFileName()
* @see #unsetFileName()
* @see #setFileName(String)
* @see org.eclipse.uml2.uml.UMLPackage#getArtifact_FileName()
* @model unsettable="true" dataType="org.eclipse.uml2.types.String" ordered="false"
* @generated
*/
String getFileName();
/**
* Sets the value of the '{@link org.eclipse.uml2.uml.Artifact#getFileName File Name}' attribute.
*
*
* @param value the new value of the 'File Name' attribute.
* @see #isSetFileName()
* @see #unsetFileName()
* @see #getFileName()
* @generated
*/
void setFileName(String value);
/**
* Unsets the value of the '{@link org.eclipse.uml2.uml.Artifact#getFileName File Name}' attribute.
*
*
* @see #isSetFileName()
* @see #getFileName()
* @see #setFileName(String)
* @generated
*/
void unsetFileName();
/**
* Returns whether the value of the '{@link org.eclipse.uml2.uml.Artifact#getFileName File Name}' attribute is set.
*
*
* @return whether the value of the 'File Name' attribute is set.
* @see #unsetFileName()
* @see #getFileName()
* @see #setFileName(String)
* @generated
*/
boolean isSetFileName();
/**
* Returns the value of the 'Nested Artifact' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Artifact}.
*
* This feature subsets the following features:
*
* - '{@link org.eclipse.uml2.uml.Namespace#getOwnedMembers() Owned Member}'
*
*
*
*
*
* The Artifacts that are defined (nested) within the Artifact. The association is a specialization of the ownedMember association from Namespace to NamedElement.
* From package UML::Deployments.
*
* @return the value of the 'Nested Artifact' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getArtifact_NestedArtifact()
* @model containment="true" resolveProxies="true" ordered="false"
* @generated
*/
EList getNestedArtifacts();
/**
* Creates a new {@link org.eclipse.uml2.uml.Artifact}, with the specified 'Name', and appends it to the 'Nested Artifact' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Artifact}, or null.
* @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Artifact} to create.
* @return The new {@link org.eclipse.uml2.uml.Artifact}.
* @see #getNestedArtifacts()
* @generated
*/
Artifact createNestedArtifact(String name, EClass eClass);
/**
* Creates a new {@link org.eclipse.uml2.uml.Artifact}, with the specified 'Name', and appends it to the 'Nested Artifact' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Artifact}, or null.
* @return The new {@link org.eclipse.uml2.uml.Artifact}.
* @see #getNestedArtifacts()
* @generated
*/
Artifact createNestedArtifact(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Artifact} with the specified 'Name' from the 'Nested Artifact' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Artifact} to retrieve, or null.
* @return The first {@link org.eclipse.uml2.uml.Artifact} with the specified 'Name', or null.
* @see #getNestedArtifacts()
* @generated
*/
Artifact getNestedArtifact(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Artifact} with the specified 'Name' from the 'Nested Artifact' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Artifact} 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.Artifact} to retrieve, or null.
* @param createOnDemand Whether to create a {@link org.eclipse.uml2.uml.Artifact} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.Artifact} with the specified 'Name', or null.
* @see #getNestedArtifacts()
* @generated
*/
Artifact getNestedArtifact(String name, boolean ignoreCase, EClass eClass,
boolean createOnDemand);
/**
* Returns the value of the 'Manifestation' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Manifestation}.
*
* This feature subsets the following features:
*
* - '{@link org.eclipse.uml2.uml.Element#getOwnedElements() Owned Element}'
*
*
*
*
*
* The set of model elements that are manifested in the Artifact. That is, these model elements are utilized in the construction (or generation) of the artifact.
* From package UML::Deployments.
*
* @return the value of the 'Manifestation' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getArtifact_Manifestation()
* @model containment="true" resolveProxies="true" ordered="false"
* @generated
*/
EList getManifestations();
/**
* Creates a new {@link org.eclipse.uml2.uml.Manifestation}, with the specified 'Name', and 'Utilized Element', and appends it to the 'Manifestation' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Manifestation}, or null.
* @param utilizedElement The 'Utilized Element' for the new {@link org.eclipse.uml2.uml.Manifestation}, or null.
* @return The new {@link org.eclipse.uml2.uml.Manifestation}.
* @see #getManifestations()
* @generated
*/
Manifestation createManifestation(String name,
PackageableElement utilizedElement);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Manifestation} with the specified 'Name', and 'Utilized Element' from the 'Manifestation' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Manifestation} to retrieve, or null.
* @param utilizedElement The 'Utilized Element' of the {@link org.eclipse.uml2.uml.Manifestation} to retrieve, or null.
* @return The first {@link org.eclipse.uml2.uml.Manifestation} with the specified 'Name', and 'Utilized Element', or null.
* @see #getManifestations()
* @generated
*/
Manifestation getManifestation(String name,
PackageableElement utilizedElement);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Manifestation} with the specified 'Name', and 'Utilized Element' from the 'Manifestation' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Manifestation} to retrieve, or null.
* @param utilizedElement The 'Utilized Element' of the {@link org.eclipse.uml2.uml.Manifestation} 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.Manifestation} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.Manifestation} with the specified 'Name', and 'Utilized Element', or null.
* @see #getManifestations()
* @generated
*/
Manifestation getManifestation(String name,
PackageableElement utilizedElement, boolean ignoreCase,
boolean createOnDemand);
/**
* Returns the value of the 'Owned Operation' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Operation}.
*
* This feature subsets the following features:
*
* - '{@link org.eclipse.uml2.uml.Classifier#getFeatures() Feature}'
* - '{@link org.eclipse.uml2.uml.Namespace#getOwnedMembers() Owned Member}'
*
*
*
*
*
* The Operations defined for the Artifact. The association is a specialization of the ownedMember association.
* From package UML::Deployments.
*
* @return the value of the 'Owned Operation' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getArtifact_OwnedOperation()
* @model containment="true" resolveProxies="true"
* @generated
*/
EList getOwnedOperations();
/**
* Creates a new {@link org.eclipse.uml2.uml.Operation}, with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types', and appends it to the 'Owned Operation' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Operation}, or null.
* @param ownedParameterNames The 'Owned Parameter Names' for the new {@link org.eclipse.uml2.uml.Operation}, or null.
* @param ownedParameterTypes The 'Owned Parameter Types' for the new {@link org.eclipse.uml2.uml.Operation}, or null.
* @return The new {@link org.eclipse.uml2.uml.Operation}.
* @see #getOwnedOperations()
* @generated
*/
Operation createOwnedOperation(String name,
EList ownedParameterNames, EList ownedParameterTypes);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Operation} with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types' from the 'Owned Operation' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or null.
* @param ownedParameterNames The 'Owned Parameter Names' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or null.
* @param ownedParameterTypes The 'Owned Parameter Types' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or null.
* @return The first {@link org.eclipse.uml2.uml.Operation} with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types', or null.
* @see #getOwnedOperations()
* @generated
*/
Operation getOwnedOperation(String name, EList ownedParameterNames,
EList ownedParameterTypes);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Operation} with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types' from the 'Owned Operation' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or null.
* @param ownedParameterNames The 'Owned Parameter Names' of the {@link org.eclipse.uml2.uml.Operation} to retrieve, or null.
* @param ownedParameterTypes The 'Owned Parameter Types' of the {@link org.eclipse.uml2.uml.Operation} 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.Operation} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.Operation} with the specified 'Name', 'Owned Parameter Names', and 'Owned Parameter Types', or null.
* @see #getOwnedOperations()
* @generated
*/
Operation getOwnedOperation(String name, EList ownedParameterNames,
EList ownedParameterTypes, boolean ignoreCase,
boolean createOnDemand);
/**
* Returns the value of the 'Owned Attribute' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Property}.
*
* This feature subsets the following features:
*
* - '{@link org.eclipse.uml2.uml.Classifier#getAttributes() Attribute}'
* - '{@link org.eclipse.uml2.uml.Namespace#getOwnedMembers() Owned Member}'
*
*
*
*
*
* The attributes or association ends defined for the Artifact. The association is a specialization of the ownedMember association.
* From package UML::Deployments.
*
* @return the value of the 'Owned Attribute' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getArtifact_OwnedAttribute()
* @model containment="true" resolveProxies="true"
* @generated
*/
EList getOwnedAttributes();
/**
* Creates a new {@link org.eclipse.uml2.uml.Property}, with the specified 'Name', and 'Type', and appends it to the 'Owned Attribute' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Property}, or null.
* @param type The 'Type' for the new {@link org.eclipse.uml2.uml.Property}, or null.
* @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Property} to create.
* @return The new {@link org.eclipse.uml2.uml.Property}.
* @see #getOwnedAttributes()
* @generated
*/
Property createOwnedAttribute(String name, Type type, EClass eClass);
/**
* Creates a new {@link org.eclipse.uml2.uml.Property}, with the specified 'Name', and 'Type', and appends it to the 'Owned Attribute' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Property}, or null.
* @param type The 'Type' for the new {@link org.eclipse.uml2.uml.Property}, or null.
* @return The new {@link org.eclipse.uml2.uml.Property}.
* @see #getOwnedAttributes()
* @generated
*/
Property createOwnedAttribute(String name, Type type);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Property} with the specified 'Name', and 'Type' from the 'Owned Attribute' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Property} to retrieve, or null.
* @param type The 'Type' of the {@link org.eclipse.uml2.uml.Property} to retrieve, or null.
* @return The first {@link org.eclipse.uml2.uml.Property} with the specified 'Name', and 'Type', or null.
* @see #getOwnedAttributes()
* @generated
*/
Property getOwnedAttribute(String name, Type type);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Property} with the specified 'Name', and 'Type' from the 'Owned Attribute' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Property} to retrieve, or null.
* @param type The 'Type' of the {@link org.eclipse.uml2.uml.Property} 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.Property} to retrieve, or null.
* @param createOnDemand Whether to create a {@link org.eclipse.uml2.uml.Property} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.Property} with the specified 'Name', and 'Type', or null.
* @see #getOwnedAttributes()
* @generated
*/
Property getOwnedAttribute(String name, Type type, boolean ignoreCase,
EClass eClass, boolean createOnDemand);
/**
*
*
*
* Creates an operation with the specified name, parameter names, parameter types, and return type (or null) as an owned operation of this artifact.
* @param name The name for the new operation, or null.
* @param parameterNames The parameter names for the new operation, or null.
* @param parameterTypes The parameter types for the new operation, or null.
* @param returnType The return type for the new operation, or null.
*
* @model required="true" ordered="false" nameDataType="org.eclipse.uml2.types.String" nameOrdered="false" parameterNamesDataType="org.eclipse.uml2.types.String" parameterNamesMany="true" parameterNamesOrdered="false" parameterTypesMany="true" parameterTypesOrdered="false" returnTypeOrdered="false"
* @generated
*/
Operation createOwnedOperation(String name, EList parameterNames,
EList parameterTypes, Type returnType);
/**
*
*
*
* Creates a property with the specified name, type, lower bound, and upper bound as an owned attribute of this artifact.
* @param name The name for the new attribute, or null.
* @param type The type for the new attribute, or null.
* @param lower The lower bound for the new attribute.
* @param upper The upper bound for the new attribute.
*
* @model required="true" ordered="false" nameDataType="org.eclipse.uml2.types.String" nameOrdered="false" typeOrdered="false" lowerDataType="org.eclipse.uml2.types.Integer" lowerRequired="true" lowerOrdered="false" upperDataType="org.eclipse.uml2.types.UnlimitedNatural" upperRequired="true" upperOrdered="false"
* @generated
*/
Property createOwnedAttribute(String name, Type type, int lower, int upper);
} // Artifact