blob: 828f8c5d80a3be6adfc714ec9e39148f467d55e3 [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 v1.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.ecl.model;
import org.eclipse.emf.common.util.EList;
import org.eclipse.rcptt.ecl.core.Command;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Select</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.rcptt.tesla.ecl.model.Select#getControl <em>Control</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.ecl.model.Select#getItems <em>Items</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.ecl.model.Select#isAll <em>All</em>}</li>
* <li>{@link org.eclipse.rcptt.tesla.ecl.model.Select#getColumn <em>Column</em>}</li>
* </ul>
*
* @see org.eclipse.rcptt.tesla.ecl.model.TeslaPackage#getSelect()
* @model annotation="http://www.eclipse.org/ecl/docs description='Selects items.' returns='value of &lt;code&gt;control&lt;/code&gt; parameter' example='get-view \"Q7 Explorer\" | get-tree | select \"TestQ7Prj/Test scenario\" | double-click'"
* @generated
*/
public interface Select extends Command {
/**
* Returns the value of the '<em><b>Control</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Control</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Control</em>' reference.
* @see #setControl(ControlHandler)
* @see org.eclipse.rcptt.tesla.ecl.model.TeslaPackage#getSelect_Control()
* @model required="true"
* annotation="http://www.eclipse.org/ecl/input"
* annotation="http://www.eclipse.org/ecl/docs description='Table, list or tree.'"
* @generated
*/
ControlHandler getControl();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.ecl.model.Select#getControl <em>Control</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Control</em>' reference.
* @see #getControl()
* @generated
*/
void setControl(ControlHandler value);
/**
* Returns the value of the '<em><b>Items</b></em>' attribute list.
* The list contents are of type {@link java.lang.Object}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Items</em>' attribute list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Items</em>' attribute list.
* @see org.eclipse.rcptt.tesla.ecl.model.TeslaPackage#getSelect_Items()
* @model required="true"
* annotation="http://www.eclipse.org/ecl/docs description='Path of item to select.'"
* annotation="http://www.eclipse.org/ecl/meta type='string | org.eclipse.rcptt.tesla.ecl.model.ControlHandler'"
* @generated
*/
EList<Object> getItems();
/**
* Returns the value of the '<em><b>All</b></em>' attribute.
* The default value is <code>"false"</code>.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>All</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>All</em>' attribute.
* @see #setAll(boolean)
* @see org.eclipse.rcptt.tesla.ecl.model.TeslaPackage#getSelect_All()
* @model default="false"
* annotation="http://www.eclipse.org/ecl/docs description='If true, command selects all items matched by provided regular expression. For Example, &lt;code&gt;get-tree | select \"Foo.\052/Bar.*\" -all&lt;/code&gt; will select all items starting with \"Bar\", if their parents starts with \"Foo\".'"
* @generated
*/
boolean isAll();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.ecl.model.Select#isAll <em>All</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>All</em>' attribute.
* @see #isAll()
* @generated
*/
void setAll(boolean value);
/**
* Returns the value of the '<em><b>Column</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Column</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Column</em>' attribute.
* @see #setColumn(String)
* @see org.eclipse.rcptt.tesla.ecl.model.TeslaPackage#getSelect_Column()
* @model
* @generated
*/
String getColumn();
/**
* Sets the value of the '{@link org.eclipse.rcptt.tesla.ecl.model.Select#getColumn <em>Column</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Column</em>' attribute.
* @see #getColumn()
* @generated
*/
void setColumn(String value);
} // Select