| 1 | /********************************************************************** |
| 2 | * Copyright (c) 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 | **********************************************************************/ |
| 12 | package org.eclipse.linuxtools.internal.lttng2.core.control.model; |
| 13 | |
| 14 | |
| 15 | /** |
| 16 | * <p> |
| 17 | * Interface for retrieval of snapshot information of a session. |
| 18 | * </p> |
| 19 | * |
| 20 | * @author Bernd Hufmann |
| 21 | */ |
| 22 | public interface ISnapshotInfo extends ITraceInfo { |
| 23 | |
| 24 | /** |
| 25 | * @return path string where snapshot is located. |
| 26 | */ |
| 27 | String getSnapshotPath(); |
| 28 | |
| 29 | /** |
| 30 | * Sets the path string (where snapshot is located) to the given value. |
| 31 | * @param path - session path to set. |
| 32 | */ |
| 33 | void setSnapshotPath(String path); |
| 34 | |
| 35 | /** |
| 36 | * @return the snapshot ID. |
| 37 | */ |
| 38 | int getId(); |
| 39 | |
| 40 | /** |
| 41 | * Sets the snapshot ID. |
| 42 | * @param id - the ID to set. |
| 43 | */ |
| 44 | void setId(int id); |
| 45 | |
| 46 | /** |
| 47 | * Sets whether snapshot is streamed over the network or stored locally |
| 48 | * at the tracers host. |
| 49 | * |
| 50 | * @param isStreamed - <code>true</code> if streamed else <code>false</code> |
| 51 | */ |
| 52 | void setStreamedSnapshot(boolean isStreamed); |
| 53 | |
| 54 | /** |
| 55 | * Gets whether snapshot is streamed over the network or stored locally |
| 56 | * at the tracers host. |
| 57 | * |
| 58 | * @return <code>true</code> if streamed else <code>false</code> |
| 59 | */ |
| 60 | boolean isStreamedSnapshot(); |
| 61 | |
| 62 | } |