2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
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.util.List;
24 * A web service parameter set
27 public interface WsParamSetI
30 * Human readable name for parameter set
32 * @return unique string (given applicable URLs)
34 public String getName();
37 * @return notes about this parameter set
39 public String getDescription();
42 * the service endpoints for which this parameter set is valid
44 * @return one or more URLs
46 public String[] getApplicableUrls();
50 * @return null, or the file used to store this parameter set.
52 public String getSourceFile();
55 * set the filename used to store this parameter set.
59 public void setSourceFile(String newfile);
62 * is this a preset or a user modifiable parameter set
64 * @return true if set can be modified
66 public boolean isModifiable();
70 * @return arguments in preset
72 List<ArgumentI> getArguments();
75 * set the arguments for the preset. Should this preset instance be
76 * unmodifiable, an Error should be thrown.
80 public void setArguments(List<ArgumentI> args);