blob: ffa22abed4e5514f48631e5fe6d75e0f54bf62c6 [file] [log] [blame]
/**
* Copyright (c) 2010, 2019 Mia-Software and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* Nicolas Payneau (Mia-Software) - initial API and implementation
*/
package org.eclipse.modisco.omg.smm;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Element</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.modisco.omg.smm.SmmElement#getAttribute <em>Attribute</em>}</li>
* <li>{@link org.eclipse.modisco.omg.smm.SmmElement#getAnnotation <em>Annotation</em>}</li>
* <li>{@link org.eclipse.modisco.omg.smm.SmmElement#getName <em>Name</em>}</li>
* <li>{@link org.eclipse.modisco.omg.smm.SmmElement#getShortDescription <em>Short Description</em>}</li>
* <li>{@link org.eclipse.modisco.omg.smm.SmmElement#getDescription <em>Description</em>}</li>
* <li>{@link org.eclipse.modisco.omg.smm.SmmElement#getRequestedObservations <em>Requested Observations</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.modisco.omg.smm.SmmPackage#getSmmElement()
* @model abstract="true"
* @generated
*/
public interface SmmElement extends EObject {
/**
* Returns the value of the '<em><b>Attribute</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.modisco.omg.smm.Attribute}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Attribute</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>Attribute</em>' containment reference list.
* @see org.eclipse.modisco.omg.smm.SmmPackage#getSmmElement_Attribute()
* @model containment="true"
* @generated
*/
EList<Attribute> getAttribute();
/**
* Returns the value of the '<em><b>Annotation</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.modisco.omg.smm.Annotation}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Annotation</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>Annotation</em>' containment reference list.
* @see org.eclipse.modisco.omg.smm.SmmPackage#getSmmElement_Annotation()
* @model containment="true"
* @generated
*/
EList<Annotation> getAnnotation();
/**
* Returns the value of the '<em><b>Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>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>Name</em>' attribute.
* @see #setName(String)
* @see org.eclipse.modisco.omg.smm.SmmPackage#getSmmElement_Name()
* @model
* @generated
*/
String getName();
/**
* Sets the value of the '{@link org.eclipse.modisco.omg.smm.SmmElement#getName <em>Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Name</em>' attribute.
* @see #getName()
* @generated
*/
void setName(String value);
/**
* Returns the value of the '<em><b>Short Description</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Short Description</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Short Description</em>' attribute.
* @see #setShortDescription(String)
* @see org.eclipse.modisco.omg.smm.SmmPackage#getSmmElement_ShortDescription()
* @model
* @generated
*/
String getShortDescription();
/**
* Sets the value of the '{@link org.eclipse.modisco.omg.smm.SmmElement#getShortDescription <em>Short Description</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Short Description</em>' attribute.
* @see #getShortDescription()
* @generated
*/
void setShortDescription(String value);
/**
* Returns the value of the '<em><b>Description</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Description</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Description</em>' attribute.
* @see #setDescription(String)
* @see org.eclipse.modisco.omg.smm.SmmPackage#getSmmElement_Description()
* @model
* @generated
*/
String getDescription();
/**
* Sets the value of the '{@link org.eclipse.modisco.omg.smm.SmmElement#getDescription <em>Description</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Description</em>' attribute.
* @see #getDescription()
* @generated
*/
void setDescription(String value);
/**
* Returns the value of the '<em><b>Requested Observations</b></em>' reference list.
* The list contents are of type {@link org.eclipse.modisco.omg.smm.Observation}.
* It is bidirectional and its opposite is '{@link org.eclipse.modisco.omg.smm.Observation#getRequestedMeasures <em>Requested Measures</em>}'.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Requested Observations</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Requested Observations</em>' reference list.
* @see org.eclipse.modisco.omg.smm.SmmPackage#getSmmElement_RequestedObservations()
* @see org.eclipse.modisco.omg.smm.Observation#getRequestedMeasures
* @model opposite="requestedMeasures"
* @generated
*/
EList<Observation> getRequestedObservations();
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @model kind="operation"
* @generated
*/
EList<SmmRelationship> getInbound();
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @model kind="operation"
* @generated
*/
EList<SmmRelationship> getOutbound();
} // SmmElement