src/jalview/ws/params/WsParamSetI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, 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 java.util.List;
  21
  22 /**
  23  * A web service parameter set
  24  *
  25  */
  26 public interface WsParamSetI
  27 {
  28   /**
  29    * Human readable name for parameter set
  30    *
  31    * @return unique string (given applicable URLs)
  32    */
  33   public String getName();
  34
  35   /**
  36    * @return notes about this parameter set
  37    */
  38   public String getDescription();
  39
  40   /**
  41    * the service endpoints for which this parameter set is valid
  42    *
  43    * @return one or more URLs
  44    */
  45   public String[] getApplicableUrls();
  46
  47   /**
  48    *
  49    * @return null, or the file used to store this parameter set.
  50    */
  51   public String getSourceFile();
  52
  53   /**
  54    * set the filename used to store this parameter set.
  55    *
  56    * @newfile
  57    */
  58   public void setSourceFile(String newfile);
  59
  60   /**
  61    * is this a preset or a user modifiable parameter set
  62    *
  63    * @return true if set can be modified
  64    */
  65   public boolean isModifiable();
  66
  67   /**
  68    *
  69    * @return arguments in preset
  70    */
  71   List<ArgumentI> getArguments();
  72
  73   /**
  74    * set the arguments for the preset. Should this preset instance be
  75    * unmodifiable, an Error should be thrown.
  76    *
  77    * @param args
  78    */
  79   public void setArguments(List<ArgumentI> args);
  80 }