lttng/org.eclipse.tracecompass.lttng2.control.ui/src/org/eclipse/tracecompass/internal/lttng2/control/ui/views/dialogs/IGetEventInfoDialog.java

   1 /**********************************************************************
   2  * Copyright (c) 2012, 2014 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Bernd Hufmann - Initial API and implementation
  11  *   Bernd Hufmann - Updated for support of LTTng Tools 2.1
  12  **********************************************************************/
  13 package org.eclipse.tracecompass.internal.lttng2.control.ui.views.dialogs;
  14
  15 import org.eclipse.tracecompass.internal.lttng2.control.core.model.TraceDomainType;
  16 import org.eclipse.tracecompass.internal.lttng2.control.ui.views.model.impl.TraceChannelComponent;
  17 import org.eclipse.tracecompass.internal.lttng2.control.ui.views.model.impl.TraceSessionComponent;
  18
  19 /**
  20  * <p>
  21  * Interface for a dialog box for collecting information about the events to enable.
  22  * </p>
  23  *
  24  * @author Bernd Hufmann
  25  */
  26 public interface IGetEventInfoDialog {
  27
  28     // ------------------------------------------------------------------------
  29     // Accessors
  30     // ------------------------------------------------------------------------
  31     /**
  32      * @return the session the events shall be enabled.
  33      */
  34     TraceSessionComponent getSession();
  35
  36     /**
  37      * @return the channel the events shall be enabled. Null for default channel.
  38      */
  39     TraceChannelComponent getChannel();
  40
  41     /**
  42      * Sets the domain type.
  43      * @param domain domain type ({@link TraceDomainType})
  44      */
  45     void setDomain(TraceDomainType domain);
  46
  47     /**
  48      * Sets available session.
  49      * @param sessions - a array of available sessions.
  50      */
  51     void setSessions(TraceSessionComponent[] sessions);
  52
  53     /**
  54      * Returns the filter expression.
  55      * @return the filter expression or null for no filtering
  56      */
  57     String getFilterExpression();
  58
  59     // ------------------------------------------------------------------------
  60     // Operations
  61     // ------------------------------------------------------------------------
  62     /**
  63      * @return returns the open return value
  64      */
  65     int open();
  66 }