blob: a4263953dd8ecbe2769a74fe9462cc0fc495ea64 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2009, 2019 Xored Software Inc 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
* https://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* Xored Software Inc - initial API and implementation and/or initial documentation
*******************************************************************************/
package org.eclipse.rcptt.tesla.core.protocol.raw;
import org.eclipse.rcptt.tesla.core.ui.Widget;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Command Transfer</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransfer#getCommand <em>Command</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransfer#getElements <em>Elements</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransfer#getKind <em>Kind</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransfer#getControls <em>Controls</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransfer#getIndex <em>Index</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransfer#getRawEvents <em>Raw Events</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getCommandTransfer()
* @model
* @generated
*/
public interface CommandTransfer extends EObject {
/**
* Returns the value of the '<em><b>Command</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Command</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Command</em>' containment reference.
* @see #setCommand(Command)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getCommandTransfer_Command()
* @model containment="true"
* @generated
*/
Command getCommand();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransfer#getCommand <em>Command</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Command</em>' containment reference.
* @see #getCommand()
* @generated
*/
void setCommand(Command value);
/**
* Returns the value of the '<em><b>Elements</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.rcptt.tesla.core.protocol.raw.Element}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Elements</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>Elements</em>' containment reference list.
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getCommandTransfer_Elements()
* @model containment="true"
* @generated
*/
EList<Element> getElements();
/**
* Returns the value of the '<em><b>Kind</b></em>' attribute.
* The literals are from the enumeration {@link org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransferKind}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Kind</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Kind</em>' attribute.
* @see org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransferKind
* @see #setKind(CommandTransferKind)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getCommandTransfer_Kind()
* @model
* @generated
*/
CommandTransferKind getKind();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransfer#getKind <em>Kind</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Kind</em>' attribute.
* @see org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransferKind
* @see #getKind()
* @generated
*/
void setKind(CommandTransferKind value);
/**
* Returns the value of the '<em><b>Controls</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.rcptt.tesla.core.ui.Widget}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Controls</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>Controls</em>' containment reference list.
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getCommandTransfer_Controls()
* @model containment="true"
* @generated
*/
EList<Widget> getControls();
/**
* Returns the value of the '<em><b>Index</b></em>' attribute.
* The default value is <code>"0"</code>.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Index</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Index</em>' attribute.
* @see #setIndex(int)
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getCommandTransfer_Index()
* @model default="0"
* @generated
*/
int getIndex();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.core.protocol.raw.CommandTransfer#getIndex <em>Index</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Index</em>' attribute.
* @see #getIndex()
* @generated
*/
void setIndex(int value);
/**
* Returns the value of the '<em><b>Raw Events</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.rcptt.tesla.core.protocol.raw.RawEvent}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Raw Events</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>Raw Events</em>' containment reference list.
* @see org.eclipse.rcptt.tesla.core.protocol.raw.RawPackage#getCommandTransfer_RawEvents()
* @model containment="true"
* @generated
*/
EList<RawEvent> getRawEvents();
} // CommandTransfer