src/jalview/ws/params/ParamManager.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, 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
  21 /**
  22  * Interface implemented by classes for maintaining user's parameters in a
  23  * Jalview session
  24  *
  25  * @author JimP
  26  *
  27  */
  28 public interface ParamManager
  29 {
  30   /**
  31    *
  32    * @param name
  33    *          (may be null) select parameter sets with given name
  34    * @param serviceUrl
  35    *          (may be null) select parameter sets that are applicable for the
  36    *          given URL
  37    * @param modifiable
  38    *          - if true, return modifiable parameter sets
  39    * @param unmodifiable
  40    *          - if true, return server presets
  41    * @return null if no parameters found, or one or more parameter sets
  42    */
  43   public WsParamSetI[] getParameterSet(String name, String serviceUrl,
  44           boolean modifiable, boolean unmodifiable);
  45
  46   /**
  47    * save the given parameter set in the user's parameter set database. Note:
  48    * this may result in a modal dialog box being raised.
  49    *
  50    * @param parameterSet
  51    */
  52   public void storeParameterSet(WsParamSetI parameterSet);
  53
  54   /**
  55    * delete the specified parameter set from the database. Note: this may result
  56    * in a modal dialog box being raised.
  57    *
  58    * @param parameterSet
  59    */
  60   public void deleteParameterSet(WsParamSetI parameterSet);
  61
  62   /**
  63    * register a parser for the given host url
  64    *
  65    * @param hosturl
  66    * @param jabaParamStore
  67    */
  68   public void registerParser(String hosturl, ParamDatastoreI paramdataStore);
  69
  70 }