You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by sa...@apache.org on 2012/07/07 02:02:51 UTC
svn commit: r1358475 - /incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataManager.java

Author: samindaw
Date: Sat Jul  7 00:02:50 2012
New Revision: 1358475

URL: http://svn.apache.org/viewvc?rev=1358475&view=rev
Log:
adding comments

Modified:
    incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataManager.java

Modified: incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataManager.java
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataManager.java?rev=1358475&r1=1358474&r2=1358475&view=diff
==============================================================================
--- incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataManager.java (original)
+++ incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataManager.java Sat Jul  7 00:02:50 2012
@@ -29,105 +29,106 @@ import java.util.List;
  *  Airvata services running at the backend
  */
 public interface AiravataManager {
+	
     /**
-     *
-     * @return
+     * Return a list of GFaC service urls registered in the system
+     * @return 0 or more urls
      * @throws AiravataAPIInvocationException
      */
 	public List<URI> getGFaCURLs() throws AiravataAPIInvocationException;
 
     /**
-     *
-     * @return
+     * Return a the first GFaC service url registered in the system
+     * @return url or null if a url is not registered
      * @throws AiravataAPIInvocationException
      */
 	public URI getGFaCURL() throws AiravataAPIInvocationException;
 
     /**
-     *
+     * Return a the first GFaC service url registered in the system orelse return the <code>defaultURL</code>
      * @param defaultURL
-     * @return
+     * @return url
      * @throws AiravataAPIInvocationException
      */
 	public URI getGFaCURL(URI defaultURL) throws AiravataAPIInvocationException;
 
     /**
-     *
-     * @return
+     * Return a list of Workflow Interpreter service urls registered in the system
+     * @return 0 or more urls
      * @throws AiravataAPIInvocationException
      */
 	public List<URI> getWorkflowInterpreterServiceURLs() throws AiravataAPIInvocationException;
 
     /**
-     *
-     * @return
+     * Return a the first Workflow interpreter service url registered in the system
+     * @return url or null if a url is not registered
      * @throws AiravataAPIInvocationException
      */
 	public URI getWorkflowInterpreterServiceURL() throws AiravataAPIInvocationException;
 
     /**
-     *
+     * Return a the first GFaC service url registered in the system orelse return the <code>defaultURL</code>
      * @param defaultURL
-     * @return
+     * @return url
      * @throws AiravataAPIInvocationException
      */
 	public URI getWorkflowInterpreterServiceURL(URI defaultURL) throws AiravataAPIInvocationException;
 
     /**
-     *
-     * @return
+     * Return a list of Workflow Interpreter service urls registered in the system
+     * @return 0 or more urls
      * @throws AiravataAPIInvocationException
      */
 	public List<URI> getMessageBoxServiceURLs() throws AiravataAPIInvocationException;
 
     /**
-     *
-     * @return
+     * Return a the first Workflow interpreter service url registered in the system
+     * @return url or null if a url is not registered
      * @throws AiravataAPIInvocationException
      */
 	public URI getMessageBoxServiceURL() throws AiravataAPIInvocationException;
 
     /**
-     *
+     * Return a the first GFaC service url registered in the system orelse return the <code>defaultURL</code>
      * @param defaultURL
-     * @return
+     * @return url
      * @throws AiravataAPIInvocationException
      */
 	public URI getMessageBoxServiceURL(URI defaultURL) throws AiravataAPIInvocationException;
 
     /**
-     *
-     * @return
+     * Return a list of Workflow Interpreter service urls registered in the system
+     * @return 0 or more urls
      * @throws AiravataAPIInvocationException
      */
 	public List<URI> getEventingServiceURLs() throws AiravataAPIInvocationException;
 
     /**
-     *
-     * @return
+     * Return a the first Workflow interpreter service url registered in the system
+     * @return url or null if a url is not registered
      * @throws AiravataAPIInvocationException
      */
 	public URI getEventingServiceURL() throws AiravataAPIInvocationException;
 
     /**
-     *
+     * Return a the first GFaC service url registered in the system orelse return the <code>defaultURL</code>
      * @param defaultURL
-     * @return
+     * @return url
      * @throws AiravataAPIInvocationException
      */
 	public URI getEventingServiceURL(URI defaultURL) throws AiravataAPIInvocationException;
 
     /**
-     *
-     * @return
+     * Return the Airavata registry url 
+     * @return url or null if url is not defined
      * @throws AiravataAPIInvocationException
      */
 	public URI getRegistryURL() throws AiravataAPIInvocationException;
 
     /**
-     *
+     * Return the Airavata registry url or return default url
      * @param defaultURL
-     * @return
+     * @return url
      * @throws AiravataAPIInvocationException
      */
 	public URI getRegistryURL(URI defaultURL) throws AiravataAPIInvocationException;