src/jalview/ws/params/WsParamSetI.java

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