org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/uml2sd/handlers/provider/ISDFindProvider.java

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2014 IBM Corporation, Ericsson
   3  * All rights reserved.   This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM - Initial API and implementation
  10  *     Bernd Hufmann - Updated for TMF
  11  **********************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.ui.views.uml2sd.handlers.provider;
  14
  15 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.dialogs.Criteria;
  16
  17 /**
  18  * Interface for providing a find provider.
  19  *
  20  * Sequence Diagram loaders which implement this class provide the actions for finding the sequence diagram. This
  21  * interface also allow the implementor to set which action/feature are supported.<br>
  22  *
  23  * Action provider are associated to a Sequence Diagram view by calling <code>SDView.setSDFindProvider()</code>.<br>
  24  *
  25  * Note that either provider implementing ISDFindProvider or IExtendedFindProvider can be active in the SDView.<br>
  26  *
  27  * @version 1.0
  28  * @author sveyrier
  29  *
  30  */
  31 public interface ISDFindProvider extends ISDGraphNodeSupporter {
  32
  33     /**
  34      * Called when the Find dialog box OK button is pressed
  35      *
  36      * @param toApply user selection made in the dialog box
  37      * @return true if the find got a non empty result
  38      */
  39     boolean find(Criteria toApply);
  40
  41     /**
  42      * Called when dialog is closed
  43      */
  44     void cancel();
  45
  46 }