blob: 380b5ae5154e5e37f9349d108ed22b40bb5d0d10 [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: Include.java,v 1.9 2006/05/26 18:16:52 khussey Exp $
*/
package org.eclipse.uml2;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Include</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* Include is a DirectedRelationship between two use cases, implying that the behavior of the included use case is inserted into the behavior of the including use case. It is also a kind of NamedElement so that it can have a name in the context of its owning use case. The including use case may only depend on the result (value) of the included use case. This value is obtained as a result of the execution of the included use case. Note that the included use case is not optional, and is always required for the including use case to execute correctly.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.uml2.Include#getIncludingCase <em>Including Case</em>}</li>
* <li>{@link org.eclipse.uml2.Include#getAddition <em>Addition</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.uml2.UML2Package#getInclude()
* @model
* @generated
*/
public interface Include extends NamedElement, DirectedRelationship {
/**
* <!-- 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>Including Case</b></em>' container reference.
* It is bidirectional and its opposite is '{@link org.eclipse.uml2.UseCase#getIncludes <em>Include</em>}'.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Including Case</em>' container reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* References the use case which will include the addition and owns the include relationship. (Specializes DirectedRelationship.source.)
* <!-- end-model-doc -->
* @return the value of the '<em>Including Case</em>' container reference.
* @see #setIncludingCase(UseCase)
* @see org.eclipse.uml2.UML2Package#getInclude_IncludingCase()
* @see org.eclipse.uml2.UseCase#getIncludes
* @model opposite="include" required="true"
* @generated
*/
UseCase getIncludingCase();
/**
* Sets the value of the '{@link org.eclipse.uml2.Include#getIncludingCase <em>Including Case</em>}' container reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Including Case</em>' container reference.
* @see #getIncludingCase()
* @generated
*/
void setIncludingCase(UseCase value);
/**
* Returns the value of the '<em><b>Addition</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Addition</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* References the use case that is to be included. (Specializes DirectedRelationship.target.)
* <!-- end-model-doc -->
* @return the value of the '<em>Addition</em>' reference.
* @see #setAddition(UseCase)
* @see org.eclipse.uml2.UML2Package#getInclude_Addition()
* @model required="true"
* @generated
*/
UseCase getAddition();
/**
* Sets the value of the '{@link org.eclipse.uml2.Include#getAddition <em>Addition</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Addition</em>' reference.
* @see #getAddition()
* @generated
*/
void setAddition(UseCase value);
} // Include