src/jalview/ws/params/ParamManager.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
   3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.ws.params;
  19
  20 import jalview.ws.jws2.dm.JabaWsParamSet;
  21
  22 /**
  23  * Interface implemented by classes for maintaining user's parameters in a Jalview session
  24  * @author JimP
  25  *
  26  */
  27 public interface ParamManager
  28 {
  29   /**
  30    *
  31    * @param name (may be null) select parameter sets with given name
  32    * @param serviceUrl (may be null) select parameter sets that are applicable for the given URL
  33    * @param modifiable - if true, return modifiable parameter sets
  34    * @param unmodifiable - if true, return server presets
  35    * @return null if no parameters found, or one or more parameter sets
  36    */
  37   public WsParamSetI[] getParameterSet(String name, String serviceUrl, boolean modifiable,boolean unmodifiable);
  38   /**
  39    * save the given parameter set in the user's parameter set database.
  40    * Note: this may result in a modal dialog box being raised.
  41    * @param parameterSet
  42    */
  43   public void storeParameterSet(WsParamSetI parameterSet);
  44   /**
  45    * delete the specified parameter set from the database.
  46    * Note: this may result in a modal dialog box being raised.
  47    * @param parameterSet
  48    */
  49   public void deleteParameterSet(WsParamSetI parameterSet);
  50   /**
  51    * register a parser for the given host url
  52    * @param hosturl
  53    * @param jabaParamStore
  54    */
  55   public void registerParser(String hosturl, ParamDatastoreI paramdataStore);
  56
  57
  58 }