org.eclipse.fmc.mm/src/org/eclipse/fmc/mm/Channel.java

/*******************************************************************************
 * <copyright>
 *
 * Copyright (c) 2013, 2013 SAP AG.
 * 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:
 *    SAP AG - initial API, implementation and documentation
 *
 * </copyright>
 *
 *******************************************************************************/
package org.eclipse.fmc.mm;


/**
 * <!-- begin-user-doc -->
 * A representation of the model object '<em><b>Channel</b></em>'.
 * <!-- end-user-doc -->
 *
 * <!-- begin-model-doc -->
 * Channel contains transient data
 * <!-- end-model-doc -->
 *
 * <p>
 * The following features are supported:
 * <ul>
 *   <li>{@link org.eclipse.fmc.mm.Channel#getChannelType <em>Channel Type</em>}</li>
 *   <li>{@link org.eclipse.fmc.mm.Channel#getSource <em>Source</em>}</li>
 *   <li>{@link org.eclipse.fmc.mm.Channel#getTarget <em>Target</em>}</li>
 *   <li>{@link org.eclipse.fmc.mm.Channel#getDataflowDirection <em>Dataflow Direction</em>}</li>
 *   <li>{@link org.eclipse.fmc.mm.Channel#getName <em>Name</em>}</li>
 * </ul>
 * </p>
 *
 * @see org.eclipse.fmc.mm.FmcPackage#getChannel()
 * @model
 * @generated
 */
public interface Channel extends FMCConnection {
	/**
	 * Returns the value of the '<em><b>Channel Type</b></em>' attribute.
	 * The literals are from the enumeration {@link org.eclipse.fmc.mm.RequestDirection}.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Channel Type</em>' attribute isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Channel Type</em>' attribute.
	 * @see org.eclipse.fmc.mm.RequestDirection
	 * @see #setChannelType(RequestDirection)
	 * @see org.eclipse.fmc.mm.FmcPackage#getChannel_ChannelType()
	 * @model required="true"
	 * @generated
	 */
	RequestDirection getChannelType();

	/**
	 * Sets the value of the '{@link org.eclipse.fmc.mm.Channel#getChannelType <em>Channel Type</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Channel Type</em>' attribute.
	 * @see org.eclipse.fmc.mm.RequestDirection
	 * @see #getChannelType()
	 * @generated
	 */
	void setChannelType(RequestDirection value);

	/**
	 * Returns the value of the '<em><b>Source</b></em>' reference.
	 * It is bidirectional and its opposite is '{@link org.eclipse.fmc.mm.Agent#getSourceChannels <em>Source Channels</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Source</em>' reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Source</em>' reference.
	 * @see #setSource(Agent)
	 * @see org.eclipse.fmc.mm.FmcPackage#getChannel_Source()
	 * @see org.eclipse.fmc.mm.Agent#getSourceChannels
	 * @model opposite="sourceChannels" required="true"
	 * @generated
	 */
	Agent getSource();

	/**
	 * Sets the value of the '{@link org.eclipse.fmc.mm.Channel#getSource <em>Source</em>}' reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Source</em>' reference.
	 * @see #getSource()
	 * @generated
	 */
	void setSource(Agent value);

	/**
	 * Returns the value of the '<em><b>Target</b></em>' reference.
	 * It is bidirectional and its opposite is '{@link org.eclipse.fmc.mm.Agent#getTargetChannels <em>Target Channels</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Target</em>' reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Target</em>' reference.
	 * @see #setTarget(Agent)
	 * @see org.eclipse.fmc.mm.FmcPackage#getChannel_Target()
	 * @see org.eclipse.fmc.mm.Agent#getTargetChannels
	 * @model opposite="targetChannels" required="true"
	 * @generated
	 */
	Agent getTarget();

	/**
	 * Sets the value of the '{@link org.eclipse.fmc.mm.Channel#getTarget <em>Target</em>}' reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Target</em>' reference.
	 * @see #getTarget()
	 * @generated
	 */
	void setTarget(Agent value);

	/**
	 * Returns the value of the '<em><b>Dataflow Direction</b></em>' attribute.
	 * The literals are from the enumeration {@link org.eclipse.fmc.mm.DataflowDirection}.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Dataflow Direction</em>' attribute isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Dataflow Direction</em>' attribute.
	 * @see org.eclipse.fmc.mm.DataflowDirection
	 * @see #setDataflowDirection(DataflowDirection)
	 * @see org.eclipse.fmc.mm.FmcPackage#getChannel_DataflowDirection()
	 * @model
	 * @generated
	 */
	DataflowDirection getDataflowDirection();

	/**
	 * Sets the value of the '{@link org.eclipse.fmc.mm.Channel#getDataflowDirection <em>Dataflow Direction</em>}' attribute.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Dataflow Direction</em>' attribute.
	 * @see org.eclipse.fmc.mm.DataflowDirection
	 * @see #getDataflowDirection()
	 * @generated
	 */
	void setDataflowDirection(DataflowDirection value);

	/**
	 * 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.fmc.mm.FmcPackage#getChannel_Name()
	 * @model
	 * @generated
	 */
	String getName();

	/**
	 * Sets the value of the '{@link org.eclipse.fmc.mm.Channel#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);

} // Channel