| /** |
| * Copyright (c) 2015 CEA LIST. |
| * |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * Benoit Maggi (CEA LIST) benoit.maggi@cea.fr - Initial API and implementation |
| * |
| */ |
| package org.eclipse.papyrus.sysml14.requirements; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| import org.eclipse.emf.ecore.EClass; |
| import org.eclipse.emf.ecore.EObject; |
| |
| import org.eclipse.uml2.uml.NamedElement; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Requirement</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * |
| * A requirement specifies a capability or condition that must (or should) be satisfied. A requirement may specify a function that a system must perform or a performance condition that a system must satisfy. Requirements are used to establish a contract between the customer (or other stakeholder) and those responsible for designing and implementing the system. |
| * |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * </p> |
| * <ul> |
| * <li>{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getBase_Class <em>Base Class</em>}</li> |
| * <li>{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getDerived <em>Derived</em>}</li> |
| * <li>{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getDerivedFrom <em>Derived From</em>}</li> |
| * <li>{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getId <em>Id</em>}</li> |
| * <li>{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getMaster <em>Master</em>}</li> |
| * <li>{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getRefinedBy <em>Refined By</em>}</li> |
| * <li>{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getSatisfiedBy <em>Satisfied By</em>}</li> |
| * <li>{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getText <em>Text</em>}</li> |
| * <li>{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getTracedTo <em>Traced To</em>}</li> |
| * <li>{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getVerifiedBy <em>Verified By</em>}</li> |
| * </ul> |
| * |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement() |
| * @model |
| * @generated |
| */ |
| public interface Requirement extends EObject { |
| /** |
| * Returns the value of the '<em><b>Base Class</b></em>' reference. |
| * <!-- begin-user-doc --> |
| * <p> |
| * If the meaning of the '<em>Base Class</em>' reference isn't clear, |
| * there really should be more of a description here... |
| * </p> |
| * <!-- end-user-doc --> |
| * @return the value of the '<em>Base Class</em>' reference. |
| * @see #setBase_Class(org.eclipse.uml2.uml.Class) |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement_Base_Class() |
| * @model ordered="false" |
| * @generated |
| */ |
| org.eclipse.uml2.uml.Class getBase_Class(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getBase_Class <em>Base Class</em>}' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Base Class</em>' reference. |
| * @see #getBase_Class() |
| * @generated |
| */ |
| void setBase_Class(org.eclipse.uml2.uml.Class value); |
| |
| /** |
| * Returns the value of the '<em><b>Derived</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.papyrus.sysml14.requirements.Requirement}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Derived from all requirements that are the client of a «deriveReqt» relationship for which this requirement is a supplier. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Derived</em>' reference list. |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement_Derived() |
| * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| EList<Requirement> getDerived(); |
| |
| /** |
| * Returns the value of the '<em><b>Derived From</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.papyrus.sysml14.requirements.Requirement}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Derived from all requirements that are the supplier of a «deriveReqt» relationship for which this requirement is a client. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Derived From</em>' reference list. |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement_DerivedFrom() |
| * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| EList<Requirement> getDerivedFrom(); |
| |
| /** |
| * Returns the value of the '<em><b>Id</b></em>' attribute. |
| * The default value is <code>""</code>. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The unique id of the requirement. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Id</em>' attribute. |
| * @see #setId(String) |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement_Id() |
| * @model default="" dataType="org.eclipse.uml2.types.String" required="true" ordered="false" |
| * @generated |
| */ |
| String getId(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getId <em>Id</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Id</em>' attribute. |
| * @see #getId() |
| * @generated |
| */ |
| void setId(String value); |
| |
| /** |
| * Returns the value of the '<em><b>Master</b></em>' reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * This is a derived property that lists the master requirement for this slave requirement. The master attribute is derived from the supplier of the Copy dependency that has this requirement as the slave. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Master</em>' reference. |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement_Master() |
| * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| Requirement getMaster(); |
| |
| /** |
| * Returns the value of the '<em><b>Refined By</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.NamedElement}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Derived from all elements that are the client of a «refine» relationship for which this requirement is a supplier. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Refined By</em>' reference list. |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement_RefinedBy() |
| * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| EList<NamedElement> getRefinedBy(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>' from the '<em><b>Refined By</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.NamedElement} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getRefinedBy() |
| * @generated |
| */ |
| NamedElement getRefinedBy(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>' from the '<em><b>Refined By</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.NamedElement} 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.uml.NamedElement} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getRefinedBy() |
| * @generated |
| */ |
| NamedElement getRefinedBy(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Satisfied By</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.NamedElement}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Derived from all elements that are the client of a «satisfy» relationship for which this requirement is a supplier. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Satisfied By</em>' reference list. |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement_SatisfiedBy() |
| * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| EList<NamedElement> getSatisfiedBy(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>' from the '<em><b>Satisfied By</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.NamedElement} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getSatisfiedBy() |
| * @generated |
| */ |
| NamedElement getSatisfiedBy(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>' from the '<em><b>Satisfied By</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.NamedElement} 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.uml.NamedElement} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getSatisfiedBy() |
| * @generated |
| */ |
| NamedElement getSatisfiedBy(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Text</b></em>' attribute. |
| * The default value is <code>""</code>. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The textual representation or a reference to the textual representation of the requirement. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Text</em>' attribute. |
| * @see #setText(String) |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement_Text() |
| * @model default="" dataType="org.eclipse.uml2.types.String" required="true" ordered="false" |
| * @generated |
| */ |
| String getText(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.papyrus.sysml14.requirements.Requirement#getText <em>Text</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Text</em>' attribute. |
| * @see #getText() |
| * @generated |
| */ |
| void setText(String value); |
| |
| /** |
| * Returns the value of the '<em><b>Traced To</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.NamedElement}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Derived from all elements that are the client of a «trace» relationship for which this requirement is a supplier. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Traced To</em>' reference list. |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement_TracedTo() |
| * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| EList<NamedElement> getTracedTo(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>' from the '<em><b>Traced To</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.NamedElement} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getTracedTo() |
| * @generated |
| */ |
| NamedElement getTracedTo(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>' from the '<em><b>Traced To</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.NamedElement} 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.uml.NamedElement} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getTracedTo() |
| * @generated |
| */ |
| NamedElement getTracedTo(String name, boolean ignoreCase, EClass eClass); |
| |
| /** |
| * Returns the value of the '<em><b>Verified By</b></em>' reference list. |
| * The list contents are of type {@link org.eclipse.uml2.uml.NamedElement}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Derived from all elements that are the client of a «verify» relationship for which this requirement is a supplier. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Verified By</em>' reference list. |
| * @see org.eclipse.papyrus.sysml14.requirements.RequirementsPackage#getRequirement_VerifiedBy() |
| * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false" |
| * @generated |
| */ |
| EList<NamedElement> getVerifiedBy(); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>' from the '<em><b>Verified By</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.NamedElement} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getVerifiedBy() |
| * @generated |
| */ |
| NamedElement getVerifiedBy(String name); |
| |
| /** |
| * Retrieves the first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>' from the '<em><b>Verified By</b></em>' reference list. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' of the {@link org.eclipse.uml2.uml.NamedElement} 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.uml.NamedElement} to retrieve, or <code>null</code>. |
| * @return The first {@link org.eclipse.uml2.uml.NamedElement} with the specified '<em><b>Name</b></em>', or <code>null</code>. |
| * @see #getVerifiedBy() |
| * @generated |
| */ |
| NamedElement getVerifiedBy(String name, boolean ignoreCase, EClass eClass); |
| |
| } // Requirement |
