2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
3 * Copyright (C) 2014 The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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 * The Jalview Authors are detailed in the 'AUTHORS' file.
19 package jalview.ws.params;
21 import java.io.IOException;
22 import java.util.List;
24 public interface ParamDatastoreI
27 public List<WsParamSetI> getPresets();
29 public WsParamSetI getPreset(String name);
31 public List<ArgumentI> getServiceParameters();
33 public boolean presetExists(String name);
35 public void deletePreset(String name);
38 * writes or overwrites the record for a modifiable WsParamSetI entry with a
39 * given name in the datastore.
44 * may throw an illegal argument RunTimeException if the presetName
45 * overwrites an existing, unmodifiable preset.
47 public void storePreset(String presetName, String text,
48 List<ArgumentI> jobParams);
51 * update an existing instance with a new name, descriptive text and
59 public void updatePreset(String oldName, String presetName, String text,
60 List<ArgumentI> jobParams);
63 * factory method - builds a service specific parameter object using the given
70 * @param parameterfile
71 * Service specific jalview parameter file (as returned from new
73 * @return null or valid WsParamSetI object for this service.
76 public WsParamSetI parseServiceParameterFile(String name,
77 String description, String[] serviceURL, String parameters)
81 * create the service specific parameter file for this pset object.
84 * @return string representation of the parameters specified by this set.
87 public String generateServiceParameterFile(WsParamSetI pset)