| 1 | /********************************************************************** |
| 2 | * Copyright (c) 2012, 2013 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.linuxtools.internal.lttng2.ui.views.control.dialogs; |
| 14 | |
| 15 | import org.eclipse.linuxtools.internal.lttng2.ui.views.control.model.impl.TraceSessionGroup; |
| 16 | |
| 17 | /** |
| 18 | * <p> |
| 19 | * Interface for create session dialog. |
| 20 | * </p> |
| 21 | * |
| 22 | * @author Bernd Hufmann |
| 23 | */ |
| 24 | public interface ICreateSessionDialog { |
| 25 | |
| 26 | // ------------------------------------------------------------------------ |
| 27 | // Accessors |
| 28 | // ------------------------------------------------------------------------ |
| 29 | /** |
| 30 | * @return the session name. |
| 31 | */ |
| 32 | String getSessionName(); |
| 33 | |
| 34 | /** |
| 35 | * @return the session path (null for default path) |
| 36 | */ |
| 37 | String getSessionPath(); |
| 38 | |
| 39 | /** |
| 40 | * @return true for default location else false |
| 41 | */ |
| 42 | boolean isDefaultSessionPath(); |
| 43 | |
| 44 | /** |
| 45 | * Initializes the dialog box. |
| 46 | * @param group - the session group |
| 47 | */ |
| 48 | void initialize(TraceSessionGroup group); |
| 49 | |
| 50 | /** |
| 51 | * @return true if traces is to be streamed else false. |
| 52 | */ |
| 53 | boolean isStreamedTrace(); |
| 54 | |
| 55 | /** |
| 56 | * Get the network URL in case control and data is configured together otherwise null |
| 57 | * If it returns a non-null value, getControlUrl() and getDataUrl() have to return null. |
| 58 | * @return The network URL or null. |
| 59 | */ |
| 60 | String getNetworkUrl(); |
| 61 | |
| 62 | /** |
| 63 | * Get the control URL in case control and data is configured separately. |
| 64 | * If it returns a non-null value, getDataUrl() has to return a valid value too |
| 65 | * and getNetworkUrl() has to return null. |
| 66 | * |
| 67 | * @return The control URL or null. |
| 68 | */ |
| 69 | String getControlUrl(); |
| 70 | |
| 71 | /** |
| 72 | * Get the data URL in case control and data is configured separately. |
| 73 | * If it returns a non-null value, getControlUrl() has to return a valid value too |
| 74 | * and getNetworkUrl() has to return null. |
| 75 | * |
| 76 | * @return The data URL or null. |
| 77 | */ |
| 78 | String getDataUrl(); |
| 79 | |
| 80 | // ------------------------------------------------------------------------ |
| 81 | // Operations |
| 82 | // ------------------------------------------------------------------------ |
| 83 | /** |
| 84 | * @return the open return value |
| 85 | */ |
| 86 | int open(); |
| 87 | } |