Clover icon

Coverage Report

  1. Project Clover database Wed Nov 13 2024 18:27:33 GMT
  2. Package jalview.ws.params

File ParamManager.java

 

Code metrics

0
0
0
1
73
10
0
-
-
0
-

Classes

Class Line # Actions
ParamManager 30 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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