airavata-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From samin...@apache.org
Subject svn commit: r1405198 - in /airavata/trunk/modules: airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java registry/registry-api/src/main/java/org/apache/airavata/registry/api/ProvenanceRegistry.java
Date Fri, 02 Nov 2012 22:39:06 GMT
Author: samindaw
Date: Fri Nov  2 22:39:06 2012
New Revision: 1405198

URL: http://svn.apache.org/viewvc?rev=1405198&view=rev
Log:
add functions to the API to return workflow inputs, return all workflows (published &
private), work with published workflows from airavata api, search experiments by their name
etc.

Modified:
    airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java
    airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/ProvenanceRegistry.java

Modified: airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java
URL: http://svn.apache.org/viewvc/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java?rev=1405198&r1=1405197&r2=1405198&view=diff
==============================================================================
--- airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java
(original)
+++ airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java
Fri Nov  2 22:39:06 2012
@@ -189,22 +189,89 @@ public interface WorkflowManager {
      */
     public List<String> getWorkflowServiceNodeIDs(String templateID) throws AiravataAPIInvocationException;
     
-
+    /**
+     * Check if the workflow from the given name is published in the system
+     * @param workflowName
+     * @return
+     * @throws AiravataAPIInvocationException
+     */
 	public boolean isPublishedWorkflowExists(String workflowName) throws AiravataAPIInvocationException;
+	
+	/**
+	 * Publish the workflow "workflowName" residing user space to the published space under
name  publishWorkflowName
+	 * @param workflowName
+	 * @param publishWorkflowName
+	 * @throws AiravataAPIInvocationException
+	 */
 	public void publishWorkflow(String workflowName, String publishWorkflowName) throws AiravataAPIInvocationException;
+	
+	/**
+	 * Publish the workflow "workflowName" residing user space
+	 * @param workflowName
+	 * @throws AiravataAPIInvocationException
+	 */
 	public void publishWorkflow(String workflowName) throws AiravataAPIInvocationException;
 	
+	/**
+	 * Retrive published workflow
+	 * @param workflowName
+	 * @return
+	 * @throws AiravataAPIInvocationException
+	 */
 	public String getPublishedWorkflowGraphXML(String workflowName) throws AiravataAPIInvocationException;
+	
+	/**
+	 * Retrive published workflow
+	 * @param workflowName
+	 * @return
+	 * @throws AiravataAPIInvocationException
+	 */
 	public Workflow getPublishedWorkflow(String workflowName) throws AiravataAPIInvocationException;
+	
+	/**
+	 * Retrive published workflow names
+	 * @return
+	 * @throws AiravataAPIInvocationException
+	 */
 	public List<String> getPublishedWorkflowNames() throws AiravataAPIInvocationException;
+	
+	/**
+	 * Retrive published workflows
+	 * @return
+	 * @throws AiravataAPIInvocationException
+	 */
 	public Map<String,Workflow> getPublishedWorkflows() throws AiravataAPIInvocationException;
 	
+	/**
+	 * Remove published workflow from the system
+	 * @param workflowName
+	 * @throws AiravataAPIInvocationException
+	 */
 	public void removePublishedWorkflow(String workflowName)throws AiravataAPIInvocationException;
 
-    public List<WorkflowInput> getWorkflowInputs(String workflowName) throws AiravataAPIInvocationException,
Exception;
+    /**
+     * get workflow inputs of the workflow
+     * @param workflowName
+     * @return
+     * @throws AiravataAPIInvocationException
+     * @throws Exception
+     */
+	public List<WorkflowInput> getWorkflowInputs(String workflowName) throws AiravataAPIInvocationException,
Exception;
     
+    /**
+     * Retrieve the workflow inputs for a workflow
+     * @param workflowData
+     * @return
+     * @throws AiravataAPIInvocationException
+     * @throws Exception
+     */
     public List<WorkflowInput> getWorkflowInputs(WorkflowData workflowData) throws
AiravataAPIInvocationException, Exception;
     
+    /**
+     * Retrieve all workflows in published space & user space accessible to the user.

+     * @return
+     * @throws AiravataAPIInvocationException
+     */
     public List<WorkflowData> getAllWorkflows() throws AiravataAPIInvocationException;
     
 }

Modified: airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/ProvenanceRegistry.java
URL: http://svn.apache.org/viewvc/airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/ProvenanceRegistry.java?rev=1405198&r1=1405197&r2=1405198&view=diff
==============================================================================
--- airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/ProvenanceRegistry.java
(original)
+++ airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/ProvenanceRegistry.java
Fri Nov  2 22:39:06 2012
@@ -263,6 +263,13 @@ public interface ProvenanceRegistry exte
 	
 	public List<ExperimentData> getAllExperimentMetaInformation(String user)throws RegistryException;
 	
+	/**
+	 * Retrieve experiments which their names match the regular expression experimentNameRegex
+	 * @param user
+	 * @param experimentNameRegex
+	 * @return
+	 * @throws RegistryException
+	 */
 	public List<ExperimentData> searchExperiments(String user, String experimentNameRegex)throws
RegistryException;
     
     /**



Mime
View raw message