blob: 6cb3b8407f6c8082e5cad0a861625709d62b8250 [file] [log] [blame]
/*
* Copyright (c) 2003, 2005 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: ReadLinkAction.java,v 1.7 2005/06/15 20:06:01 khussey Exp $
*/
package org.eclipse.uml2;
import org.eclipse.emf.ecore.EClass;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Read Link Action</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* This action navigates an association towards one end, which is the end that does not have an input pin to take its object (the “open” end). The objects put on the result output pin are the ones participating in the association at the open end, conforming to the specified qualifiers, in order if the end is ordered. The semantics is undefined for reading a link that violates the navigability or visibility of the open end.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.uml2.ReadLinkAction#getResult <em>Result</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.uml2.UML2Package#getReadLinkAction()
* @model
* @generated
*/
public interface ReadLinkAction extends LinkAction{
/**
* <!-- 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>Result</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Result</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* (Specialized from Action:output) The pin on which are put the objects participating in the association at the end not specified by the inputs.
* <!-- end-model-doc -->
* @return the value of the '<em>Result</em>' containment reference.
* @see #setResult(OutputPin)
* @see org.eclipse.uml2.UML2Package#getReadLinkAction_Result()
* @model containment="true" required="true"
* @generated
*/
OutputPin getResult();
/**
* Sets the value of the '{@link org.eclipse.uml2.ReadLinkAction#getResult <em>Result</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Result</em>' containment reference.
* @see #getResult()
* @generated
*/
void setResult(OutputPin value);
/**
* Creates a {@link org.eclipse.uml2.OutputPin} and sets the '<em><b>Result</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param eClass The Ecore class of the {@link org.eclipse.uml2.OutputPin} to create.
* @return The new {@link org.eclipse.uml2.OutputPin}.
* @see #getResult()
* @generated NOT
* @deprecated Use #createResult() instead.
*/
OutputPin createResult(EClass eClass);
/**
* Creates a {@link org.eclipse.uml2.OutputPin} and sets the '<em><b>Result</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return The new {@link org.eclipse.uml2.OutputPin}.
* @see #getResult()
* @generated
*/
OutputPin createResult();
} // ReadLinkAction