org.eclipse.uml2.uml.Interaction 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, 418466
* Christian W. Damus (CEA) - 251963
*
*/
package org.eclipse.uml2.uml;
import java.util.Map;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EClass;
/**
*
* A representation of the model object 'Interaction'.
*
*
*
* An Interaction is a unit of Behavior that focuses on the observable exchange of information between connectable elements.
* From package UML::Interactions.
*
*
*
* The following features are supported:
*
* - {@link org.eclipse.uml2.uml.Interaction#getLifelines Lifeline}
* - {@link org.eclipse.uml2.uml.Interaction#getFragments Fragment}
* - {@link org.eclipse.uml2.uml.Interaction#getActions Action}
* - {@link org.eclipse.uml2.uml.Interaction#getFormalGates Formal Gate}
* - {@link org.eclipse.uml2.uml.Interaction#getMessages Message}
*
*
*
* @see org.eclipse.uml2.uml.UMLPackage#getInteraction()
* @model
* @generated
*/
public interface Interaction
extends Behavior, InteractionFragment {
/**
* Returns the value of the 'Lifeline' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Lifeline}.
* It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.Lifeline#getInteraction Interaction}'.
*
* This feature subsets the following features:
*
* - '{@link org.eclipse.uml2.uml.Namespace#getOwnedMembers() Owned Member}'
*
*
*
*
*
* Specifies the participants in this Interaction.
* From package UML::Interactions.
*
* @return the value of the 'Lifeline' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getInteraction_Lifeline()
* @see org.eclipse.uml2.uml.Lifeline#getInteraction
* @model opposite="interaction" containment="true" resolveProxies="true" ordered="false"
* @generated
*/
EList getLifelines();
/**
* Creates a new {@link org.eclipse.uml2.uml.Lifeline}, with the specified 'Name', and appends it to the 'Lifeline' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Lifeline}, or null.
* @return The new {@link org.eclipse.uml2.uml.Lifeline}.
* @see #getLifelines()
* @generated
*/
Lifeline createLifeline(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Lifeline} with the specified 'Name' from the 'Lifeline' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Lifeline} to retrieve, or null.
* @return The first {@link org.eclipse.uml2.uml.Lifeline} with the specified 'Name', or null.
* @see #getLifelines()
* @generated
*/
Lifeline getLifeline(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Lifeline} with the specified 'Name' from the 'Lifeline' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Lifeline} 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.Lifeline} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.Lifeline} with the specified 'Name', or null.
* @see #getLifelines()
* @generated
*/
Lifeline getLifeline(String name, boolean ignoreCase, boolean createOnDemand);
/**
* Returns the value of the 'Fragment' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.InteractionFragment}.
* It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.InteractionFragment#getEnclosingInteraction Enclosing Interaction}'.
*
* This feature subsets the following features:
*
* - '{@link org.eclipse.uml2.uml.Namespace#getOwnedMembers() Owned Member}'
*
*
*
*
*
* The ordered set of fragments in the Interaction.
* From package UML::Interactions.
*
* @return the value of the 'Fragment' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getInteraction_Fragment()
* @see org.eclipse.uml2.uml.InteractionFragment#getEnclosingInteraction
* @model opposite="enclosingInteraction" containment="true" resolveProxies="true"
* @generated
*/
EList getFragments();
/**
* Creates a new {@link org.eclipse.uml2.uml.InteractionFragment}, with the specified 'Name', and appends it to the 'Fragment' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.InteractionFragment}, or null.
* @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.InteractionFragment} to create.
* @return The new {@link org.eclipse.uml2.uml.InteractionFragment}.
* @see #getFragments()
* @generated
*/
InteractionFragment createFragment(String name, EClass eClass);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.InteractionFragment} with the specified 'Name' from the 'Fragment' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.InteractionFragment} to retrieve, or null.
* @return The first {@link org.eclipse.uml2.uml.InteractionFragment} with the specified 'Name', or null.
* @see #getFragments()
* @generated
*/
InteractionFragment getFragment(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.InteractionFragment} with the specified 'Name' from the 'Fragment' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.InteractionFragment} 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.InteractionFragment} to retrieve, or null.
* @param createOnDemand Whether to create a {@link org.eclipse.uml2.uml.InteractionFragment} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.InteractionFragment} with the specified 'Name', or null.
* @see #getFragments()
* @generated
*/
InteractionFragment getFragment(String name, boolean ignoreCase,
EClass eClass, boolean createOnDemand);
/**
* Returns the value of the 'Action' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Action}.
*
* This feature subsets the following features:
*
* - '{@link org.eclipse.uml2.uml.Element#getOwnedElements() Owned Element}'
*
*
*
*
*
* Actions owned by the Interaction.
* From package UML::Interactions.
*
* @return the value of the 'Action' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getInteraction_Action()
* @model containment="true" resolveProxies="true" ordered="false"
* @generated
*/
EList getActions();
/**
* Creates a new {@link org.eclipse.uml2.uml.Action}, with the specified 'Name', and appends it to the 'Action' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Action}, or null.
* @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.Action} to create.
* @return The new {@link org.eclipse.uml2.uml.Action}.
* @see #getActions()
* @generated
*/
Action createAction(String name, EClass eClass);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Action} with the specified 'Name' from the 'Action' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Action} to retrieve, or null.
* @return The first {@link org.eclipse.uml2.uml.Action} with the specified 'Name', or null.
* @see #getActions()
* @generated
*/
Action getAction(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Action} with the specified 'Name' from the 'Action' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Action} 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.Action} to retrieve, or null.
* @param createOnDemand Whether to create a {@link org.eclipse.uml2.uml.Action} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.Action} with the specified 'Name', or null.
* @see #getActions()
* @generated
*/
Action getAction(String name, boolean ignoreCase, EClass eClass,
boolean createOnDemand);
/**
* Returns the value of the 'Formal Gate' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Gate}.
*
* This feature subsets the following features:
*
* - '{@link org.eclipse.uml2.uml.Namespace#getOwnedMembers() Owned Member}'
*
*
*
*
*
* Specifies the gates that form the message interface between this Interaction and any InteractionUses which reference it.
* From package UML::Interactions.
*
* @return the value of the 'Formal Gate' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getInteraction_FormalGate()
* @model containment="true" resolveProxies="true" ordered="false"
* @generated
*/
EList getFormalGates();
/**
* Creates a new {@link org.eclipse.uml2.uml.Gate}, with the specified 'Name', and appends it to the 'Formal Gate' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Gate}, or null.
* @return The new {@link org.eclipse.uml2.uml.Gate}.
* @see #getFormalGates()
* @generated
*/
Gate createFormalGate(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Gate} with the specified 'Name' from the 'Formal Gate' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Gate} to retrieve, or null.
* @return The first {@link org.eclipse.uml2.uml.Gate} with the specified 'Name', or null.
* @see #getFormalGates()
* @generated
*/
Gate getFormalGate(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Gate} with the specified 'Name' from the 'Formal Gate' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Gate} 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.Gate} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.Gate} with the specified 'Name', or null.
* @see #getFormalGates()
* @generated
*/
Gate getFormalGate(String name, boolean ignoreCase, boolean createOnDemand);
/**
* Returns the value of the 'Message' containment reference list.
* The list contents are of type {@link org.eclipse.uml2.uml.Message}.
* It is bidirectional and its opposite is '{@link org.eclipse.uml2.uml.Message#getInteraction Interaction}'.
*
* This feature subsets the following features:
*
* - '{@link org.eclipse.uml2.uml.Namespace#getOwnedMembers() Owned Member}'
*
*
*
*
*
* The Messages contained in this Interaction.
* From package UML::Interactions.
*
* @return the value of the 'Message' containment reference list.
* @see org.eclipse.uml2.uml.UMLPackage#getInteraction_Message()
* @see org.eclipse.uml2.uml.Message#getInteraction
* @model opposite="interaction" containment="true" resolveProxies="true" ordered="false"
* @generated
*/
EList getMessages();
/**
* Creates a new {@link org.eclipse.uml2.uml.Message}, with the specified 'Name', and appends it to the 'Message' containment reference list.
*
*
* @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Message}, or null.
* @return The new {@link org.eclipse.uml2.uml.Message}.
* @see #getMessages()
* @generated
*/
Message createMessage(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Message} with the specified 'Name' from the 'Message' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Message} to retrieve, or null.
* @return The first {@link org.eclipse.uml2.uml.Message} with the specified 'Name', or null.
* @see #getMessages()
* @generated
*/
Message getMessage(String name);
/**
* Retrieves the first {@link org.eclipse.uml2.uml.Message} with the specified 'Name' from the 'Message' containment reference list.
*
*
* @param name The 'Name' of the {@link org.eclipse.uml2.uml.Message} 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.Message} on demand if not found.
* @return The first {@link org.eclipse.uml2.uml.Message} with the specified 'Name', or null.
* @see #getMessages()
* @generated
*/
Message getMessage(String name, boolean ignoreCase, boolean createOnDemand);
/**
*
*
*
* An Interaction instance must not be contained within another Interaction instance.
* enclosingInteraction->isEmpty()
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model
* @generated
*/
boolean validateNotContained(DiagnosticChain diagnostics,
Map context);
} // Interaction