src/jalview/ws/params/ParamManager.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ws.params;
  22
  23
  24 /**
  25  * Interface implemented by classes for maintaining user's parameters in a
  26  * Jalview session
  27  *
  28  * @author JimP
  29  *
  30  */
  31 public interface ParamManager
  32 {
  33   /**
  34    *
  35    * @param name
  36    *          (may be null) select parameter sets with given name
  37    * @param serviceUrl
  38    *          (may be null) select parameter sets that are applicable for the
  39    *          given URL
  40    * @param modifiable
  41    *          - if true, return modifiable parameter sets
  42    * @param unmodifiable
  43    *          - if true, return server presets
  44    * @return null if no parameters found, or one or more parameter sets
  45    */
  46   public WsParamSetI[] getParameterSet(String name, String serviceUrl,
  47           boolean modifiable, boolean unmodifiable);
  48
  49   /**
  50    * save the given parameter set in the user's parameter set database. Note:
  51    * this may result in a modal dialog box being raised.
  52    *
  53    * @param parameterSet
  54    */
  55   public void storeParameterSet(WsParamSetI parameterSet);
  56
  57   /**
  58    * delete the specified parameter set from the database. Note: this may result
  59    * in a modal dialog box being raised.
  60    *
  61    * @param parameterSet
  62    */
  63   public void deleteParameterSet(WsParamSetI parameterSet);
  64
  65   /**
  66    * register a parser for the given host url
  67    *
  68    * @param hosturl
  69    * @param jabaParamStore
  70    */
  71   public void registerParser(String hosturl, ParamDatastoreI paramdataStore);
  72
  73 }