X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fws%2Fparams%2FWsParamSetI.java;h=781aa0ddacd93a2ddffb911a48d15c4c88ebac89;hb=f8c81e5adaada96c5255a539e9d26447bccce3e5;hp=3f0fec303de70ea74bc3f938658272994820b656;hpb=153dd62dc91da13ae732600e6ea55ddbe15eab39;p=jalview.git diff --git a/src/jalview/ws/params/WsParamSetI.java b/src/jalview/ws/params/WsParamSetI.java index 3f0fec3..781aa0d 100644 --- a/src/jalview/ws/params/WsParamSetI.java +++ b/src/jalview/ws/params/WsParamSetI.java @@ -21,47 +21,59 @@ import java.util.List; /** * A web service parameter set - * + * */ public interface WsParamSetI { /** * Human readable name for parameter set + * * @return unique string (given applicable URLs) */ public String getName(); + /** * @return notes about this parameter set */ public String getDescription(); + /** * the service endpoints for which this parameter set is valid + * * @return one or more URLs */ public String[] getApplicableUrls(); + /** * * @return null, or the file used to store this parameter set. */ public String getSourceFile(); - + /** * set the filename used to store this parameter set. - * @newfile + * + * @newfile */ public void setSourceFile(String newfile); + /** * is this a preset or a user modifiable parameter set + * * @return true if set can be modified */ public boolean isModifiable(); + /** * * @return arguments in preset */ - List getArguments(); + List getArguments(); + /** - * set the arguments for the preset. Should this preset instance be unmodifiable, an Error should be thrown. + * set the arguments for the preset. Should this preset instance be + * unmodifiable, an Error should be thrown. + * * @param args */ public void setArguments(List args);