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