svn commit: r1421909 - /airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/workflow/ExperimentData.java

[la...@apache.org]

Author: lahiru
Date: Fri Dec 14 14:55:36 2012
New Revision: 1421909

URL: http://svn.apache.org/viewvc?rev=1421909&view=rev
Log:
Adding comments to registry-api classes.

Modified:
    airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/workflow/ExperimentData.java

Modified: airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/workflow/ExperimentData.java
URL: http://svn.apache.org/viewvc/airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/workflow/ExperimentData.java?rev=1421909&r1=1421908&r2=1421909&view=diff
==============================================================================
--- airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/workflow/ExperimentData.java (original)
+++ airavata/trunk/modules/registry/registry-api/src/main/java/org/apache/airavata/registry/api/workflow/ExperimentData.java Fri Dec 14 14:55:36 2012
@@ -33,19 +33,86 @@ import javax.xml.bind.annotation.XmlRoot
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
 public interface ExperimentData extends WorkflowInstanceData {
+    //Current Id and Topic values are similar
+
+    /**
+     * Returns the ExeperimentID of the workflow Run
+     * @return
+     */
     public String getId();
+
+    /**
+     * Returns the Experiment Topic... Currently the ID and the Topic are identical
+     * @return
+     */
 	public String getTopic();
+
+    /**
+     * Returns the user of the workflow run
+     * @return
+     */
 	public String getUser();
+
+    /**
+     * Returns metadata related to the workflow run
+     * @return
+     */
 	public String getMetadata();
+
+    /**
+     * Returns the Experiment Name of the workflow run, This is given in the XBaya-GUI when you user run a workflow
+     * @return
+     */
 	public String getExperimentName();
+
+    /**
+     * get data related to a particular experiment, this returns all the workflow runs for the given Experiment
+     * @return
+     * @throws ExperimentLazyLoadedException
+     */
 	public List<WorkflowInstanceDataImpl> getWorkflowInstanceData() throws ExperimentLazyLoadedException;
+
+    /**
+     * Reut
+     * @param workflowInstanceID
+     * @return
+     * @throws ExperimentLazyLoadedException
+     */
     public WorkflowInstanceData getWorkflowInstance(String workflowInstanceID) throws ExperimentLazyLoadedException;
 
+    /**
+     *
+     * @param experimentId
+     */
     public void setExperimentId(String experimentId);
+
+    /**
+     *
+     * @param topic
+     */
 	public void setTopic(String topic);
+
+    /**
+     *
+     * @param user
+     */
 	public void setUser(String user);
+
+    /**
+     *
+     * @param metadata
+     */
 	public void setMetadata(String metadata);
+
+    /**
+     *
+     * @param experimentName
+     */
 	public void setExperimentName(String experimentName);
-    
+
+    /**
+     *
+     * @return
+     */
 	public String getExperimentId();
 }