39afc8c80aa1e84501f22a8b5cb65031d5a51d95
[jalview.git] / src / jalview / ws / params / ParamManager.java
1 package jalview.ws.params;
2
3 import jalview.ws.jws2.dm.JabaWsParamSet;
4
5 /**
6  * Interface implemented by classes for maintaining user's parameters in a Jalview session
7  * @author JimP
8  *
9  */
10 public interface ParamManager
11 {
12   /**
13    * 
14    * @param name (may be null) select parameter sets with given name
15    * @param serviceUrl (may be null) select parameter sets that are applicable for the given URL
16    * @param modifiable - if true, return modifiable parameter sets
17    * @param unmodifiable - if true, return server presets
18    * @return null if no parameters found, or one or more parameter sets
19    */
20   public WsParamSetI[] getParameterSet(String name, String serviceUrl, boolean modifiable,boolean unmodifiable);
21   /**
22    * save the given parameter set in the user's parameter set database.
23    * Note: this may result in a modal dialog box being raised.
24    * @param parameterSet
25    */
26   public void storeParameterSet(WsParamSetI parameterSet);
27   /**
28    * delete the specified parameter set from the database.
29    * Note: this may result in a modal dialog box being raised.
30    * @param parameterSet
31    */
32   public void deleteParameterSet(WsParamSetI parameterSet);
33   /**
34    * register a parser for the given host url
35    * @param hosturl
36    * @param jabaParamStore
37    */
38   public void registerParser(String hosturl, ParamDatastoreI paramdataStore);
39   
40
41 }