X-Git-Url: http://source.jalview.org/gitweb/?p=proteocache.git;a=blobdiff_plain;f=server%2Fcompbio%2Fws%2Fjpred%2FJpred.java;fp=server%2Fcompbio%2Fws%2Fjpred%2FJpred.java;h=72b1a9efe461f0df9349883851bbac23bc34265d;hp=4b4a96541cdb377c742ee328dcd0ca82eab96ea7;hb=d533fe6c1adf9f81009386ce42a9beb6999f7c3c;hpb=e42ffa7fff3b1bcc7b85451ab0914422d36d8324

diff --git a/server/compbio/ws/jpred/Jpred.java b/server/compbio/ws/jpred/Jpred.java
index 4b4a965..72b1a9e 100644
--- a/server/compbio/ws/jpred/Jpred.java
+++ b/server/compbio/ws/jpred/Jpred.java
@@ -4,17 +4,58 @@ import javax.jws.WebMethod;
 import javax.jws.WebParam;
 import javax.jws.WebService;
 
+/**
+ * Jpred interface of the corresponding web serice in ProteoCache
+ * 
+ * @author Alexander Sherstnev
+ * @author Natasha Sherstneva
+ * 
+ * @version 1.0
+ * @since Jan 2014
+ */
 @WebService(targetNamespace = "http://server.proteocache.ws")
 public interface Jpred {
 
+	/**
+	 * Returns a number of jobs xecuted for a protein with a program of a
+	 * version
+	 * 
+	 * @param sequence
+	 *            the protein sequence
+	 * @param program
+	 *            the program title
+	 * @param version
+	 *            the program version
+	 * @return a number of jobs executed for the protein
+	 */
 	@WebMethod
 	public String findSequence(@WebParam(name = "sequence") String sequence, @WebParam(name = "program") String program,
 			@WebParam(name = "version") String version);
 
+	/**
+	 * Returns a job ID executed for a protein with a program of a version if
+	 * the job archive file is available, otherwise returns empty string
+	 * 
+	 * @param sequence
+	 *            the protein sequence
+	 * @param program
+	 *            the program title
+	 * @param version
+	 *            the program version
+	 * @return job ID
+	 */
 	@WebMethod
 	public String findJobForSequence(@WebParam(name = "sequence") String sequence, @WebParam(name = "program") String program,
 			@WebParam(name = "version") String version);
 
+	/**
+	 * Returns a relative web link to the job archive file for a ProteoCache
+	 * job, if the file is not available null is returned
+	 * 
+	 * @param jobid
+	 *            the job ID
+	 * @return the job archive file web link or null
+	 */
 	@WebMethod
 	public String getArchive(@WebParam(name = "job") String jobid);
 }