You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by sm...@apache.org on 2014/07/04 14:11:17 UTC
svn commit: r1607838 [1/2] - in
/airavata/site/trunk/content/documentation/api-docs: ./ 0.13/
Author: smarru
Date: Fri Jul 4 12:11:16 2014
New Revision: 1607838
URL: http://svn.apache.org/r1607838
Log:
adding thrift generated docs for discussion
Added:
airavata/site/trunk/content/documentation/api-docs/
airavata/site/trunk/content/documentation/api-docs/0.13/
airavata/site/trunk/content/documentation/api-docs/0.13/airavataAPI.html
airavata/site/trunk/content/documentation/api-docs/0.13/airavataDataModel.html
airavata/site/trunk/content/documentation/api-docs/0.13/airavataErrors.html
airavata/site/trunk/content/documentation/api-docs/0.13/applicationDeploymentModel.html
airavata/site/trunk/content/documentation/api-docs/0.13/applicationInterfaceModel.html
airavata/site/trunk/content/documentation/api-docs/0.13/computeResourceModel.html
airavata/site/trunk/content/documentation/api-docs/0.13/experimentModel.html
airavata/site/trunk/content/documentation/api-docs/0.13/gatewayResourceProfileModel.html
airavata/site/trunk/content/documentation/api-docs/0.13/index.html
airavata/site/trunk/content/documentation/api-docs/0.13/style.css
airavata/site/trunk/content/documentation/api-docs/0.13/workspaceModel.html
Added: airavata/site/trunk/content/documentation/api-docs/0.13/airavataAPI.html
URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.13/airavataAPI.html?rev=1607838&view=auto
==============================================================================
--- airavata/site/trunk/content/documentation/api-docs/0.13/airavataAPI.html (added)
+++ airavata/site/trunk/content/documentation/api-docs/0.13/airavataAPI.html Fri Jul 4 12:11:16 2014
@@ -0,0 +1,571 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<link href="style.css" rel="stylesheet" type="text/css"/>
+<title>Thrift module: airavataAPI</title></head><body>
+<div class="container-fluid">
+<h1>Thrift module: airavataAPI</h1>
+<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead>
+<tr>
+<td>airavataAPI</td><td><a href="#Svc_Airavata">Airavata</a><br/>
+<ul>
+<li><a href="#Fn_Airavata_cloneExperiment">cloneExperiment</a></li>
+<li><a href="#Fn_Airavata_createExperiment">createExperiment</a></li>
+<li><a href="#Fn_Airavata_createProject">createProject</a></li>
+<li><a href="#Fn_Airavata_deleteApplicationDeployment">deleteApplicationDeployment</a></li>
+<li><a href="#Fn_Airavata_deleteApplicationInterface">deleteApplicationInterface</a></li>
+<li><a href="#Fn_Airavata_deleteApplicationModule">deleteApplicationModule</a></li>
+<li><a href="#Fn_Airavata_getAPIVersion">getAPIVersion</a></li>
+<li><a href="#Fn_Airavata_getAllExperimentsInProject">getAllExperimentsInProject</a></li>
+<li><a href="#Fn_Airavata_getAllUserExperiments">getAllUserExperiments</a></li>
+<li><a href="#Fn_Airavata_getAllUserProjects">getAllUserProjects</a></li>
+<li><a href="#Fn_Airavata_getAppModuleDeployedResources">getAppModuleDeployedResources</a></li>
+<li><a href="#Fn_Airavata_getApplicationDeployment">getApplicationDeployment</a></li>
+<li><a href="#Fn_Airavata_getApplicationInputs">getApplicationInputs</a></li>
+<li><a href="#Fn_Airavata_getApplicationInterface">getApplicationInterface</a></li>
+<li><a href="#Fn_Airavata_getApplicationModule">getApplicationModule</a></li>
+<li><a href="#Fn_Airavata_getApplicationOutputs">getApplicationOutputs</a></li>
+<li><a href="#Fn_Airavata_getExperiment">getExperiment</a></li>
+<li><a href="#Fn_Airavata_getExperimentOutputs">getExperimentOutputs</a></li>
+<li><a href="#Fn_Airavata_getExperimentStatus">getExperimentStatus</a></li>
+<li><a href="#Fn_Airavata_getJobStatuses">getJobStatuses</a></li>
+<li><a href="#Fn_Airavata_getProject">getProject</a></li>
+<li><a href="#Fn_Airavata_launchExperiment">launchExperiment</a></li>
+<li><a href="#Fn_Airavata_registerApplicationDeployment">registerApplicationDeployment</a></li>
+<li><a href="#Fn_Airavata_registerApplicationInterface">registerApplicationInterface</a></li>
+<li><a href="#Fn_Airavata_registerApplicationModule">registerApplicationModule</a></li>
+<li><a href="#Fn_Airavata_searchExperimentsByApplication">searchExperimentsByApplication</a></li>
+<li><a href="#Fn_Airavata_searchExperimentsByDesc">searchExperimentsByDesc</a></li>
+<li><a href="#Fn_Airavata_searchExperimentsByName">searchExperimentsByName</a></li>
+<li><a href="#Fn_Airavata_searchProjectsByProjectDesc">searchProjectsByProjectDesc</a></li>
+<li><a href="#Fn_Airavata_searchProjectsByProjectName">searchProjectsByProjectName</a></li>
+<li><a href="#Fn_Airavata_terminateExperiment">terminateExperiment</a></li>
+<li><a href="#Fn_Airavata_updateApplicationDeployment">updateApplicationDeployment</a></li>
+<li><a href="#Fn_Airavata_updateApplicationInterface">updateApplicationInterface</a></li>
+<li><a href="#Fn_Airavata_updateApplicationModule">updateApplicationModule</a></li>
+<li><a href="#Fn_Airavata_updateExperiment">updateExperiment</a></li>
+<li><a href="#Fn_Airavata_updateExperimentConfiguration">updateExperimentConfiguration</a></li>
+<li><a href="#Fn_Airavata_updateProject">updateProject</a></li>
+<li><a href="#Fn_Airavata_updateResourceScheduleing">updateResourceScheduleing</a></li>
+<li><a href="#Fn_Airavata_validateExperiment">validateExperiment</a></li>
+</ul>
+</td>
+<td></td>
+<td><code><a href="#Const_AIRAVATA_API_VERSION">AIRAVATA_API_VERSION</a></code><br/>
+</code></td>
+</tr></table>
+<hr/><h2 id="Constants">Constants</h2>
+<table class="table-bordered table-striped table-condensed"><thead><th>Constant</th><th>Type</th><th>Value</th></thead>
+<tr id="Const_AIRAVATA_API_VERSION"><td><code>AIRAVATA_API_VERSION</code></td><td><code>string</code></td><td><code>"0.12.0"</code></td></tr></table><hr/><h2 id="Services">Services</h2>
+<h3 id="Svc_Airavata">Service: Airavata</h3>
+<div class="definition"><h4 id="Fn_Airavata_getAPIVersion">Function: Airavata.getAPIVersion</h4>
+<pre><code>string</code> getAPIVersion()
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Query Airavata to fetch the API version
+<br/></div><div class="definition"><h4 id="Fn_Airavata_createProject">Function: Airavata.createProject</h4>
+<pre><code>string</code> createProject(<code><a href="workspaceModel.html#Struct_Project">workspaceModel.Project</a></code> project)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Create a Project
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateProject">Function: Airavata.updateProject</h4>
+<pre><code>void</code> updateProject(<code>string</code> projectId,
+ <code><a href="workspaceModel.html#Struct_Project">workspaceModel.Project</a></code> updatedProject)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>, <code><a href="airavataErrors.html#Struct_ProjectNotFoundException">airavataErrors.ProjectNotFoundException</a></code>
+</pre>Update a Project
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getProject">Function: Airavata.getProject</h4>
+<pre><code><a href="workspaceModel.html#Struct_Project">workspaceModel.Project</a></code> getProject(<code>string</code> projectId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>, <code><a href="airavataErrors.html#Struct_ProjectNotFoundException">airavataErrors.ProjectNotFoundException</a></code>
+</pre>Get a Project by ID
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getAllUserProjects">Function: Airavata.getAllUserProjects</h4>
+<pre><code>list<<code><a href="workspaceModel.html#Struct_Project">workspaceModel.Project</a></code>></code> getAllUserProjects(<code>string</code> userName)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Get all Project by user
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_searchProjectsByProjectName">Function: Airavata.searchProjectsByProjectName</h4>
+<pre><code>list<<code><a href="workspaceModel.html#Struct_Project">workspaceModel.Project</a></code>></code> searchProjectsByProjectName(<code>string</code> userName,
+ <code>string</code> projectName)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Get all Project for user by project name
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_searchProjectsByProjectDesc">Function: Airavata.searchProjectsByProjectDesc</h4>
+<pre><code>list<<code><a href="workspaceModel.html#Struct_Project">workspaceModel.Project</a></code>></code> searchProjectsByProjectDesc(<code>string</code> userName,
+ <code>string</code> description)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Get all Project for user by project description
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_searchExperimentsByName">Function: Airavata.searchExperimentsByName</h4>
+<pre><code>list<<code><a href="experimentModel.html#Struct_ExperimentSummary">experimentModel.ExperimentSummary</a></code>></code> searchExperimentsByName(<code>string</code> userName,
+ <code>string</code> expName)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Search Experiments by experiment name
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_searchExperimentsByDesc">Function: Airavata.searchExperimentsByDesc</h4>
+<pre><code>list<<code><a href="experimentModel.html#Struct_ExperimentSummary">experimentModel.ExperimentSummary</a></code>></code> searchExperimentsByDesc(<code>string</code> userName,
+ <code>string</code> description)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Search Experiments by experiment name
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_searchExperimentsByApplication">Function: Airavata.searchExperimentsByApplication</h4>
+<pre><code>list<<code><a href="experimentModel.html#Struct_ExperimentSummary">experimentModel.ExperimentSummary</a></code>></code> searchExperimentsByApplication(<code>string</code> userName,
+ <code>string</code> applicationId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Search Experiments by application id
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getAllExperimentsInProject">Function: Airavata.getAllExperimentsInProject</h4>
+<pre><code>list<<code><a href="experimentModel.html#Struct_Experiment">experimentModel.Experiment</a></code>></code> getAllExperimentsInProject(<code>string</code> projectId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>, <code><a href="airavataErrors.html#Struct_ProjectNotFoundException">airavataErrors.ProjectNotFoundException</a></code>
+</pre>Get all Experiments within a Project
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getAllUserExperiments">Function: Airavata.getAllUserExperiments</h4>
+<pre><code>list<<code><a href="experimentModel.html#Struct_Experiment">experimentModel.Experiment</a></code>></code> getAllUserExperiments(<code>string</code> userName)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Get all Experiments by user
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_createExperiment">Function: Airavata.createExperiment</h4>
+<pre><code>string</code> createExperiment(<code><a href="experimentModel.html#Struct_Experiment">experimentModel.Experiment</a></code> experiment)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Create an experiment for the specified user belonging to the gateway. The gateway identity is not explicitly passed
+ but inferred from the authentication header. This experiment is just a persistent place holder. The client
+ has to subsequently configure and launch the created experiment. No action is taken on Airavata Server except
+ registering the experiment in a persistent store.
+<p/>
+@param basicExperimentMetadata
+ The create experiment will require the basic experiment metadata like the name and description, intended user,
+ the gateway identifer and if the experiment should be shared public by defualt. During the creation of an experiment
+ the ExperimentMetadata is a required field.
+<p/>
+@return
+ The server-side generated airavata experiment globally unique identifier.
+<p/>
+@throws org.apache.airavata.model.error.InvalidRequestException
+ For any incorrect forming of the request itself.
+<p/>
+@throws org.apache.airavata.model.error.AiravataClientException
+ The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve:
+<p/>
+ UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative
+ step, then Airavata Registry will not have a provenance area setup. The client has to follow
+ gateway registration steps and retry this request.
+<p/>
+ AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined.
+ For now this is a place holder.
+<p/>
+ INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake
+ is implemented, the authorization will be more substantial.
+<p/>
+@throws org.apache.airavata.model.error.AiravataSystemException
+ This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client
+ rather an Airavata Administrator will be notified to take corrective action.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getExperiment">Function: Airavata.getExperiment</h4>
+<pre><code><a href="experimentModel.html#Struct_Experiment">experimentModel.Experiment</a></code> getExperiment(<code>string</code> airavataExperimentId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_ExperimentNotFoundException">airavataErrors.ExperimentNotFoundException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch previously created experiment metadata.
+<p/>
+@param airavataExperimentId
+ The identifier for the requested experiment. This is returned during the create experiment step.
+<p/>
+@return experimentMetada
+ This method will return the previously stored experiment metadata.
+<p/>
+@throws org.apache.airavata.model.error.InvalidRequestException
+ For any incorrect forming of the request itself.
+<p/>
+@throws org.apache.airavata.model.error.ExperimentNotFoundException
+ If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown.
+<p/>
+@throws org.apache.airavata.model.error.AiravataClientException
+ The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve:
+
+ UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative
+ step, then Airavata Registry will not have a provenance area setup. The client has to follow
+ gateway registration steps and retry this request.
+<p/>
+ AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined.
+ For now this is a place holder.
+<p/>
+ INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake
+ is implemented, the authorization will be more substantial.
+<p/>
+@throws org.apache.airavata.model.error.AiravataSystemException
+ This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client
+ rather an Airavata Administrator will be notified to take corrective action.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateExperiment">Function: Airavata.updateExperiment</h4>
+<pre><code>void</code> updateExperiment(<code>string</code> airavataExperimentId,
+ <code><a href="experimentModel.html#Struct_Experiment">experimentModel.Experiment</a></code> experiment)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_ExperimentNotFoundException">airavataErrors.ExperimentNotFoundException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Configure a previously created experiment with required inputs, scheduling and other quality of service
+ parameters. This method only updates the experiment object within the registry. The experiment has to be launched
+ to make it actionable by the server.
+<p/>
+@param airavataExperimentId
+ The identifier for the requested experiment. This is returned during the create experiment step.
+<p/>
+@param experimentConfigurationData
+ The configuration information of the experiment with application input parameters, computational resource scheduling
+ information, special input output handling and additional quality of service parameters.
+<p/>
+@return
+ This method call does not have a return value.
+<p/>
+@throws org.apache.airavata.model.error.InvalidRequestException
+ For any incorrect forming of the request itself.
+<p/>
+@throws org.apache.airavata.model.error.ExperimentNotFoundException
+ If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown.
+<p/>
+@throws org.apache.airavata.model.error.AiravataClientException
+ The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve:
+
+ UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative
+ step, then Airavata Registry will not have a provenance area setup. The client has to follow
+ gateway registration steps and retry this request.
+<p/>
+ AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined.
+ For now this is a place holder.
+<p/>
+ INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake
+ is implemented, the authorization will be more substantial.
+<p/>
+@throws org.apache.airavata.model.error.AiravataSystemException
+ This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client
+ rather an Airavata Administrator will be notified to take corrective action.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateExperimentConfiguration">Function: Airavata.updateExperimentConfiguration</h4>
+<pre><code>void</code> updateExperimentConfiguration(<code>string</code> airavataExperimentId,
+ <code><a href="experimentModel.html#Struct_UserConfigurationData">experimentModel.UserConfigurationData</a></code> userConfiguration)
+</pre></div><div class="definition"><h4 id="Fn_Airavata_updateResourceScheduleing">Function: Airavata.updateResourceScheduleing</h4>
+<pre><code>void</code> updateResourceScheduleing(<code>string</code> airavataExperimentId,
+ <code><a href="experimentModel.html#Struct_ComputationalResourceScheduling">experimentModel.ComputationalResourceScheduling</a></code> resourceScheduling)
+</pre></div><div class="definition"><h4 id="Fn_Airavata_validateExperiment">Function: Airavata.validateExperiment</h4>
+<pre><code>bool</code> validateExperiment(<code>string</code> airavataExperimentId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_ExperimentNotFoundException">airavataErrors.ExperimentNotFoundException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre> *
+ * Validate experiment configuration. A true in general indicates, the experiment is ready to be launched.
+ *
+ * @param experimentID
+ * @return sucess/failure
+ *
+*
+<br/></div><div class="definition"><h4 id="Fn_Airavata_launchExperiment">Function: Airavata.launchExperiment</h4>
+<pre><code>void</code> launchExperiment(<code>string</code> airavataExperimentId,
+ <code>string</code> airavataCredStoreToken)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_ExperimentNotFoundException">airavataErrors.ExperimentNotFoundException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>, <code><a href="airavataErrors.html#Struct_LaunchValidationException">airavataErrors.LaunchValidationException</a></code>
+</pre>Launch a previously created and configured experiment. Airavata Server will then start processing the request and appropriate
+ notifications and intermediate and output data will be subsequently available for this experiment.
+<p/>
+@param airavataExperimentId
+ The identifier for the requested experiment. This is returned during the create experiment step.
+<p/>
+@param airavataCredStoreToken:
+ A requirement to execute experiments within Airavata is to first register the targeted remote computational account
+ credentials with Airavata Credential Store. The administrative API (related to credential store) will return a
+ generated token associated with the registered credentials. The client has to security posses this token id and is
+ required to pass it to Airavata Server for all execution requests.
+ Note: At this point only the credential store token is required so the string is directly passed here. In future if
+ if more security credentials are enables, then the structure ExecutionSecurityParameters should be used.
+ Note: This parameter is not persisted within Airavata Registry for security reasons.
+<p/>
+@return
+ This method call does not have a return value.
+<p/>
+@throws org.apache.airavata.model.error.InvalidRequestException
+ For any incorrect forming of the request itself.
+<p/>
+@throws org.apache.airavata.model.error.ExperimentNotFoundException
+ If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown.
+<p/>
+@throws org.apache.airavata.model.error.AiravataClientException
+ The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve:
+
+ UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative
+ step, then Airavata Registry will not have a provenance area setup. The client has to follow
+ gateway registration steps and retry this request.
+<p/>
+ AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined.
+ For now this is a place holder.
+<p/>
+ INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake
+ is implemented, the authorization will be more substantial.
+<p/>
+@throws org.apache.airavata.model.error.AiravataSystemException
+ This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client
+ rather an Airavata Administrator will be notified to take corrective action.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getExperimentStatus">Function: Airavata.getExperimentStatus</h4>
+<pre><code><a href="experimentModel.html#Struct_ExperimentStatus">experimentModel.ExperimentStatus</a></code> getExperimentStatus(<code>string</code> airavataExperimentId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_ExperimentNotFoundException">airavataErrors.ExperimentNotFoundException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre></div><div class="definition"><h4 id="Fn_Airavata_getExperimentOutputs">Function: Airavata.getExperimentOutputs</h4>
+<pre><code>list<<code><a href="experimentModel.html#Struct_DataObjectType">experimentModel.DataObjectType</a></code>></code> getExperimentOutputs(<code>string</code> airavataExperimentId)
+</pre></div><div class="definition"><h4 id="Fn_Airavata_getJobStatuses">Function: Airavata.getJobStatuses</h4>
+<pre><code>map<<code>string</code>, <code><a href="experimentModel.html#Struct_JobStatus">experimentModel.JobStatus</a></code>></code> getJobStatuses(<code>string</code> airavataExperimentId)
+</pre></div><div class="definition"><h4 id="Fn_Airavata_cloneExperiment">Function: Airavata.cloneExperiment</h4>
+<pre><code>string</code> cloneExperiment(<code>string</code> existingExperimentID,
+ <code>string</code> newExperimentName)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_ExperimentNotFoundException">airavataErrors.ExperimentNotFoundException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Clone an specified experiment with a new name. A copy of the experiment configuration is made and is persisted with new metadata.
+ The client has to subsequently update this configuration if needed and launch the cloned experiment.
+<p/>
+@param newExperimentName
+ experiment name that should be used in the cloned experiment
+<p/>
+@param updatedExperiment
+ Once an experiment is cloned, to disambiguate, the users are suggested to provide new metadata. This will again require
+ the basic experiment metadata like the name and description, intended user, the gateway identifier and if the experiment
+ should be shared public by default.
+<p/>
+@return
+ The server-side generated airavata experiment globally unique identifier for the newly cloned experiment.
+<p/>
+@throws org.apache.airavata.model.error.InvalidRequestException
+ For any incorrect forming of the request itself.
+<p/>
+@throws org.apache.airavata.model.error.ExperimentNotFoundException
+ If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown.
+<p/>
+@throws org.apache.airavata.model.error.AiravataClientException
+ The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve:
+
+ UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative
+ step, then Airavata Registry will not have a provenance area setup. The client has to follow
+ gateway registration steps and retry this request.
+<p/>
+ AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined.
+ For now this is a place holder.
+<p/>
+ INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake
+ is implemented, the authorization will be more substantial.
+<p/>
+@throws org.apache.airavata.model.error.AiravataSystemException
+ This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client
+ rather an Airavata Administrator will be notified to take corrective action.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_terminateExperiment">Function: Airavata.terminateExperiment</h4>
+<pre><code>void</code> terminateExperiment(<code>string</code> airavataExperimentId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_ExperimentNotFoundException">airavataErrors.ExperimentNotFoundException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Terminate a running experiment.
+<p/>
+@param airavataExperimentId
+ The identifier for the requested experiment. This is returned during the create experiment step.
+<p/>
+@return
+ This method call does not have a return value.
+<p/>
+@throws org.apache.airavata.model.error.InvalidRequestException
+ For any incorrect forming of the request itself.
+<p/>
+@throws org.apache.airavata.model.error.ExperimentNotFoundException
+ If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown.
+<p/>
+@throws org.apache.airavata.model.error.AiravataClientException
+ The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve:
+
+ UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative
+ step, then Airavata Registry will not have a provenance area setup. The client has to follow
+ gateway registration steps and retry this request.
+<p/>
+ AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined.
+ For now this is a place holder.
+<p/>
+ INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake
+ is implemented, the authorization will be more substantial.
+<p/>
+@throws org.apache.airavata.model.error.AiravataSystemException
+ This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client
+ rather an Airavata Administrator will be notified to take corrective action.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_registerApplicationModule">Function: Airavata.registerApplicationModule</h4>
+<pre><code>string</code> registerApplicationModule(<code><a href="applicationDeploymentModel.html#Struct_ApplicationModule">applicationDeploymentModel.ApplicationModule</a></code> applicationModule)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Register a Application Module.
+<p/>
+@param applicationModule
+ Application Module Object created from the datamodel.
+<p/>
+@return appModuleId
+ Returns a server-side generated airavata appModule globally unique identifier.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationModule">Function: Airavata.getApplicationModule</h4>
+<pre><code><a href="applicationDeploymentModel.html#Struct_ApplicationModule">applicationDeploymentModel.ApplicationModule</a></code> getApplicationModule(<code>string</code> appModuleId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch a Application Module.
+<p/>
+@param appModuleId
+ The identifier for the requested application module
+<p/>
+@return applicationModule
+ Returns a application Module Object.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateApplicationModule">Function: Airavata.updateApplicationModule</h4>
+<pre><code>bool</code> updateApplicationModule(<code>string</code> appModuleId,
+ <code><a href="applicationDeploymentModel.html#Struct_ApplicationModule">applicationDeploymentModel.ApplicationModule</a></code> applicationModule)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update a Application Module.
+<p/>
+@param appModuleId
+ The identifier for the requested application module to be updated.
+<p/>
+@param applicationModule
+ Application Module Object created from the datamodel.
+<p/>
+@return status
+ Returns a success/failure of the update.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_deleteApplicationModule">Function: Airavata.deleteApplicationModule</h4>
+<pre><code>bool</code> deleteApplicationModule(<code>string</code> appModuleId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Delete a Application Module.
+<p/>
+@param appModuleId
+ The identifier for the requested application module to be deleted.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_registerApplicationDeployment">Function: Airavata.registerApplicationDeployment</h4>
+<pre><code>string</code> registerApplicationDeployment(<code><a href="applicationDeploymentModel.html#Struct_ApplicationDeploymentDescription">applicationDeploymentModel.ApplicationDeploymentDescription</a></code> applicationDeployment)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Register a Application Deployment.
+<p/>
+@param applicationModule
+ Application Module Object created from the datamodel.
+<p/>
+@return appDeploymentId
+ Returns a server-side generated airavata appDeployment globally unique identifier.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationDeployment">Function: Airavata.getApplicationDeployment</h4>
+<pre><code><a href="applicationDeploymentModel.html#Struct_ApplicationDeploymentDescription">applicationDeploymentModel.ApplicationDeploymentDescription</a></code> getApplicationDeployment(<code>string</code> appDeploymentId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch a Application Deployment.
+<p/>
+@param appDeploymentId
+ The identifier for the requested application module
+<p/>
+@return applicationDeployment
+ Returns a application Deployment Object.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateApplicationDeployment">Function: Airavata.updateApplicationDeployment</h4>
+<pre><code>bool</code> updateApplicationDeployment(<code>string</code> appDeploymentId,
+ <code><a href="applicationDeploymentModel.html#Struct_ApplicationDeploymentDescription">applicationDeploymentModel.ApplicationDeploymentDescription</a></code> applicationDeployment)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update a Application Deployment.
+<p/>
+@param appDeploymentId
+ The identifier for the requested application deployment to be updated.
+<p/>
+@param appDeployment
+ Application Deployment Object created from the datamodel.
+<p/>
+@return status
+ Returns a success/failure of the update.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_deleteApplicationDeployment">Function: Airavata.deleteApplicationDeployment</h4>
+<pre><code>bool</code> deleteApplicationDeployment(<code>string</code> appDeploymentId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Delete a Application deployment.
+<p/>
+@param appDeploymentId
+ The identifier for the requested application deployment to be deleted.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getAppModuleDeployedResources">Function: Airavata.getAppModuleDeployedResources</h4>
+<pre><code>list<<code>string</code>></code> getAppModuleDeployedResources(<code>string</code> appModuleId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch a list of Deployed Compute Hosts.
+<p/>
+@param appModuleId
+ The identifier for the requested application module
+<p/>
+@return list<string>
+ Returns a list of Deployed Resources.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_registerApplicationInterface">Function: Airavata.registerApplicationInterface</h4>
+<pre><code>string</code> registerApplicationInterface(<code><a href="applicationInterfaceModel.html#Struct_ApplicationInterfaceDescription">applicationInterfaceModel.ApplicationInterfaceDescription</a></code> applicationInterface)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Register a Application Interface.
+<p/>
+@param applicationModule
+ Application Module Object created from the datamodel.
+<p/>
+@return appInterfaceId
+ Returns a server-side generated airavata application interface globally unique identifier.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationInterface">Function: Airavata.getApplicationInterface</h4>
+<pre><code><a href="applicationInterfaceModel.html#Struct_ApplicationInterfaceDescription">applicationInterfaceModel.ApplicationInterfaceDescription</a></code> getApplicationInterface(<code>string</code> appInterfaceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch a Application Interface.
+<p/>
+@param appInterfaceId
+ The identifier for the requested application module
+<p/>
+@return applicationInterface
+ Returns a application Interface Object.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_updateApplicationInterface">Function: Airavata.updateApplicationInterface</h4>
+<pre><code>bool</code> updateApplicationInterface(<code>string</code> appInterfaceId,
+ <code><a href="applicationInterfaceModel.html#Struct_ApplicationInterfaceDescription">applicationInterfaceModel.ApplicationInterfaceDescription</a></code> applicationInterface)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Update a Application Interface.
+<p/>
+@param appInterfaceId
+ The identifier for the requested application deployment to be updated.
+<p/>
+@param appInterface
+ Application Interface Object created from the datamodel.
+<p/>
+@return status
+ Returns a success/failure of the update.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_deleteApplicationInterface">Function: Airavata.deleteApplicationInterface</h4>
+<pre><code>bool</code> deleteApplicationInterface(<code>string</code> appInterfaceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Delete a Application Interface.
+<p/>
+@param appInterfaceId
+ The identifier for the requested application interface to be deleted.
+<p/>
+@return status
+ Returns a success/failure of the deletion.
+<p/>
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationInputs">Function: Airavata.getApplicationInputs</h4>
+<pre><code>list<<code><a href="applicationInterfaceModel.html#Struct_InputDataObjectType">applicationInterfaceModel.InputDataObjectType</a></code>></code> getApplicationInputs(<code>string</code> appInterfaceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch the list of Application Inputs.
+<p/>
+@param appInterfaceId
+ The identifier for the requested application interface
+<p/>
+@return list<applicationInterfaceModel.InputDataObjectType>
+ Returns a list of application inputs.
+<p/>
+<br/></div><div class="definition"><h4 id="Fn_Airavata_getApplicationOutputs">Function: Airavata.getApplicationOutputs</h4>
+<pre><code>list<<code><a href="applicationInterfaceModel.html#Struct_OutputDataObjectType">applicationInterfaceModel.OutputDataObjectType</a></code>></code> getApplicationOutputs(<code>string</code> appInterfaceId)
+ throws <code><a href="airavataErrors.html#Struct_InvalidRequestException">airavataErrors.InvalidRequestException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataClientException">airavataErrors.AiravataClientException</a></code>, <code><a href="airavataErrors.html#Struct_AiravataSystemException">airavataErrors.AiravataSystemException</a></code>
+</pre>Fetch the list of Application Outputs.
+<p/>
+@param appInterfaceId
+ The identifier for the requested application interface
+<p/>
+@return list<applicationInterfaceModel.OutputDataObjectType>
+ Returns a list of application outputs.
+<p/>
+<br/></div></div></body></html>
Added: airavata/site/trunk/content/documentation/api-docs/0.13/airavataDataModel.html
URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.13/airavataDataModel.html?rev=1607838&view=auto
==============================================================================
--- airavata/site/trunk/content/documentation/api-docs/0.13/airavataDataModel.html (added)
+++ airavata/site/trunk/content/documentation/api-docs/0.13/airavataDataModel.html Fri Jul 4 12:11:16 2014
@@ -0,0 +1,16 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<link href="style.css" rel="stylesheet" type="text/css"/>
+<title>Thrift module: airavataDataModel</title></head><body>
+<div class="container-fluid">
+<h1>Thrift module: airavataDataModel</h1>
+<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead>
+<tr>
+<td>airavataDataModel</td><td></td>
+<td></td>
+<td></code></td>
+</tr></table>
+</div></body></html>
Added: airavata/site/trunk/content/documentation/api-docs/0.13/airavataErrors.html
URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.13/airavataErrors.html?rev=1607838&view=auto
==============================================================================
--- airavata/site/trunk/content/documentation/api-docs/0.13/airavataErrors.html (added)
+++ airavata/site/trunk/content/documentation/api-docs/0.13/airavataErrors.html Fri Jul 4 12:11:16 2014
@@ -0,0 +1,143 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<link href="style.css" rel="stylesheet" type="text/css"/>
+<title>Thrift module: airavataErrors</title></head><body>
+<div class="container-fluid">
+<h1>Thrift module: airavataErrors</h1>
+<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead>
+<tr>
+<td>airavataErrors</td><td></td>
+<td><a href="#Struct_AiravataClientException">AiravataClientException</a><br/>
+<a href="#Enum_AiravataErrorType">AiravataErrorType</a><br/>
+<a href="#Struct_AiravataSystemException">AiravataSystemException</a><br/>
+<a href="#Struct_AuthenticationException">AuthenticationException</a><br/>
+<a href="#Struct_AuthorizationException">AuthorizationException</a><br/>
+<a href="#Struct_ExperimentNotFoundException">ExperimentNotFoundException</a><br/>
+<a href="#Struct_InvalidRequestException">InvalidRequestException</a><br/>
+<a href="#Struct_LaunchValidationException">LaunchValidationException</a><br/>
+<a href="#Struct_ProjectNotFoundException">ProjectNotFoundException</a><br/>
+<a href="#Struct_TimedOutException">TimedOutException</a><br/>
+<a href="#Struct_ValidationResults">ValidationResults</a><br/>
+<a href="#Struct_ValidatorResult">ValidatorResult</a><br/>
+</td>
+<td></code></td>
+</tr></table>
+<hr/><h2 id="Enumerations">Enumerations</h2>
+<div class="definition"><h3 id="Enum_AiravataErrorType">Enumeration: AiravataErrorType</h3>
+A list of Airavata API Error Message Types
+<p/>
+ UNKNOWN: No information available about the error
+
+ PERMISSION_DENIED: Not permitted to perform action
+<p/>
+ INTERNAL_ERROR: Unexpected problem with the service
+<p/>
+ AUTHENTICATION_FAILURE: The client failed to authenticate.
+<p/>
+ INVALID_AUTHORIZATION: Security Token and/or Username and/or password is incorrect
+
+ AUTHORIZATION_EXPIRED: Authentication token expired
+
+ UNKNOWN_GATEWAY_ID: The gateway is not registered with Airavata.
+<p/>
+ UNSUPPORTED_OPERATION: Operation denied because it is currently unsupported.
+<br/><br/><table class="table-bordered table-striped table-condensed">
+<tr><td><code>UNKNOWN</code></td><td><code>0</code></td><td>
+</td></tr>
+<tr><td><code>PERMISSION_DENIED</code></td><td><code>1</code></td><td>
+</td></tr>
+<tr><td><code>INTERNAL_ERROR</code></td><td><code>2</code></td><td>
+</td></tr>
+<tr><td><code>AUTHENTICATION_FAILURE</code></td><td><code>3</code></td><td>
+</td></tr>
+<tr><td><code>INVALID_AUTHORIZATION</code></td><td><code>4</code></td><td>
+</td></tr>
+<tr><td><code>AUTHORIZATION_EXPIRED</code></td><td><code>5</code></td><td>
+</td></tr>
+<tr><td><code>UNKNOWN_GATEWAY_ID</code></td><td><code>6</code></td><td>
+</td></tr>
+<tr><td><code>UNSUPPORTED_OPERATION</code></td><td><code>7</code></td><td>
+</td></tr>
+</table></div>
+<hr/><h2 id="Structs">Data structures</h2>
+<div class="definition"><h3 id="Struct_ExperimentNotFoundException">Exception: ExperimentNotFoundException</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+</table><br/>This exception is thrown when a client asks to perform an operation on an experiment that does not exist.
+<p/>
+identifier: A description of the experiment that was not found on the server.
+<p/>
+key: The value passed from the client in the identifier, which was not found.
+<br/></div><div class="definition"><h3 id="Struct_ProjectNotFoundException">Exception: ProjectNotFoundException</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+</table><br/>1: optional string identifier,
+2: optional string key
+<p/>
+<br/></div><div class="definition"><h3 id="Struct_InvalidRequestException">Exception: InvalidRequestException</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+</table><br/>This exception is thrown for invalid requests that occur from any reasons like required input parameters are missing,
+ or a parameter is malformed.
+<p/>
+ message: contains the associated error message.
+<br/></div><div class="definition"><h3 id="Struct_TimedOutException">Exception: TimedOutException</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+</table><br/>This exception is thrown when RPC timeout gets exceeded.
+<br/></div><div class="definition"><h3 id="Struct_AuthenticationException">Exception: AuthenticationException</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+</table><br/>This exception is thrown for invalid authentication requests.
+<p/>
+ message: contains the cause of the authorization failure.
+<br/></div><div class="definition"><h3 id="Struct_AuthorizationException">Exception: AuthorizationException</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>message</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+</table><br/>This exception is thrown for invalid authorization requests such user does not have acces to an aplication or resource.
+<p/>
+ message: contains the authorization failure message
+<br/></div><div class="definition"><h3 id="Struct_AiravataClientException">Exception: AiravataClientException</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>airavataErrorType</td><td><code><a href="airavataErrors.html#Enum_AiravataErrorType">AiravataErrorType</a></code></td><td></td><td>required</td><td></td></tr>
+<tr><td>2</td><td>parameter</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/>This exception is thrown by Airavata Services when a call fails as a result of
+a problem that a client may be able to resolve. For example, if the user
+attempts to execute an application on a resource gateway does not have access to.
+<p/>
+This exception would not be used for internal system errors that do not
+reflect user actions, but rather reflect a problem within the service that
+the client cannot resolve.
+<p/>
+airavataErrorType: The message type indicating the error that occurred.
+ must be one of the values of AiravataErrorType.
+<p/>
+parameter: If the error applied to a particular input parameter, this will
+ indicate which parameter.
+<br/></div><div class="definition"><h3 id="Struct_ValidatorResult">Struct: ValidatorResult</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>result</td><td><code>bool</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>2</td><td>errorDetails</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/></div><div class="definition"><h3 id="Struct_ValidationResults">Struct: ValidationResults</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>validationState</td><td><code>bool</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>2</td><td>validationResultList</td><td><code>list<<code><a href="airavataErrors.html#Struct_ValidatorResult">ValidatorResult</a></code>></code></td><td></td><td>required</td><td></td></tr>
+</table><br/></div><div class="definition"><h3 id="Struct_LaunchValidationException">Exception: LaunchValidationException</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>validationResult</td><td><code><a href="airavataErrors.html#Struct_ValidationResults">ValidationResults</a></code></td><td></td><td>required</td><td></td></tr>
+<tr><td>2</td><td>errorMessage</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/></div><div class="definition"><h3 id="Struct_AiravataSystemException">Exception: AiravataSystemException</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>airavataErrorType</td><td><code><a href="airavataErrors.html#Enum_AiravataErrorType">AiravataErrorType</a></code></td><td></td><td>required</td><td></td></tr>
+<tr><td>2</td><td>message</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/>This exception is thrown by Airavata Services when a call fails as a result of
+a problem in the service that could not be changed through client's action.
+<p/>
+airavataErrorType: The message type indicating the error that occurred.
+ must be one of the values of AiravataErrorType.
+<p/>
+message: This may contain additional information about the error
+<p/>
+<br/></div></div></body></html>
Added: airavata/site/trunk/content/documentation/api-docs/0.13/applicationDeploymentModel.html
URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.13/applicationDeploymentModel.html?rev=1607838&view=auto
==============================================================================
--- airavata/site/trunk/content/documentation/api-docs/0.13/applicationDeploymentModel.html (added)
+++ airavata/site/trunk/content/documentation/api-docs/0.13/applicationDeploymentModel.html Fri Jul 4 12:11:16 2014
@@ -0,0 +1,90 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<link href="style.css" rel="stylesheet" type="text/css"/>
+<title>Thrift module: applicationDeploymentModel</title></head><body>
+<div class="container-fluid">
+<h1>Thrift module: applicationDeploymentModel</h1>
+<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead>
+<tr>
+<td>applicationDeploymentModel</td><td></td>
+<td><a href="#Struct_ApplicationDeploymentDescription">ApplicationDeploymentDescription</a><br/>
+<a href="#Struct_ApplicationModule">ApplicationModule</a><br/>
+<a href="#Struct_SetEnvPaths">SetEnvPaths</a><br/>
+</td>
+<td><code><a href="#Const_DEFAULT_ID">DEFAULT_ID</a></code><br/>
+</code></td>
+</tr></table>
+<hr/><h2 id="Constants">Constants</h2>
+<table class="table-bordered table-striped table-condensed"><thead><th>Constant</th><th>Type</th><th>Value</th></thead>
+<tr id="Const_DEFAULT_ID"><td><code>DEFAULT_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr></table><hr/><h2 id="Structs">Data structures</h2>
+<div class="definition"><h3 id="Struct_SetEnvPaths">Struct: SetEnvPaths</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>2</td><td>value</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+</table><br/>Key Value pairs to be used to set environments
+<p/>
+name:
+ Name of the environment variable such as PATH, LD_LIBRARY_PATH, NETCDF_HOME.
+<p/>
+value:
+ Value of the environment variable to set
+<br/></div><div class="definition"><h3 id="Struct_ApplicationModule">Struct: ApplicationModule</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
+<tr><td>2</td><td>appModuleId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
+<tr><td>3</td><td>appModuleName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>4</td><td>appModuleVersion</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>appModuleDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/>Application Module Information. A module has to be registered before registering a deployment.
+<p/>
+appModuleId: Airavata Internal Unique Job ID. This is set by the registry.
+<p/>
+appModuleName:
+ Name of the application module.
+<p/>
+appModuleVersion:
+ Version of the application.
+<p/>
+appModuleDescription:
+ Descriprion of the Module
+<p/>
+<br/></div><div class="definition"><h3 id="Struct_ApplicationDeploymentDescription">Struct: ApplicationDeploymentDescription</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
+<tr><td>2</td><td>appDeploymentId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
+<tr><td>3</td><td>appModuleId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>4</td><td>computeHostId</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>5</td><td>executablePath</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>6</td><td>appDeploymentDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>7</td><td>moduleLoadCmds</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>8</td><td>libPrependPaths</td><td><code>list<<code><a href="applicationDeploymentModel.html#Struct_SetEnvPaths">SetEnvPaths</a></code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>9</td><td>libAppendPaths</td><td><code>list<<code><a href="applicationDeploymentModel.html#Struct_SetEnvPaths">SetEnvPaths</a></code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>10</td><td>setEnvironment</td><td><code>list<<code><a href="applicationDeploymentModel.html#Struct_SetEnvPaths">SetEnvPaths</a></code>></code></td><td></td><td>optional</td><td></td></tr>
+</table><br/>Application Deployment Description
+<p/>
+appDeploymentId: Airavata Internal Unique Job ID. This is set by the registry.
+<p/>
+appModuleName:
+ Application Module Name. This has to be precise describing the binary.
+<p/>
+computeHostId:
+ This ID maps application deployment to a particular resource previously described within Airavata.
+ Example: Stampede is first registered and refered when registering WRF.
+<p/>
+moduleLoadCmd:
+ Command string to load modules. This will be placed in the job submisison
+ Ex: module load amber
+<p/>
+libPrependPaths:
+ prepend to a path variable the value
+<p/>
+libAppendPaths:
+ append to a path variable the value
+<p/>
+setEnvironment:
+ assigns to the environment variable "NAME" the value
+<p/>
+<br/></div></div></body></html>
Added: airavata/site/trunk/content/documentation/api-docs/0.13/applicationInterfaceModel.html
URL: http://svn.apache.org/viewvc/airavata/site/trunk/content/documentation/api-docs/0.13/applicationInterfaceModel.html?rev=1607838&view=auto
==============================================================================
--- airavata/site/trunk/content/documentation/api-docs/0.13/applicationInterfaceModel.html (added)
+++ airavata/site/trunk/content/documentation/api-docs/0.13/applicationInterfaceModel.html Fri Jul 4 12:11:16 2014
@@ -0,0 +1,117 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<link href="style.css" rel="stylesheet" type="text/css"/>
+<title>Thrift module: applicationInterfaceModel</title></head><body>
+<div class="container-fluid">
+<h1>Thrift module: applicationInterfaceModel</h1>
+<table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead>
+<tr>
+<td>applicationInterfaceModel</td><td></td>
+<td><a href="#Struct_ApplicationInterfaceDescription">ApplicationInterfaceDescription</a><br/>
+<a href="#Enum_DataType">DataType</a><br/>
+<a href="#Struct_InputDataObjectType">InputDataObjectType</a><br/>
+<a href="#Struct_OutputDataObjectType">OutputDataObjectType</a><br/>
+</td>
+<td><code><a href="#Const_DEFAULT_ID">DEFAULT_ID</a></code><br/>
+</code></td>
+</tr></table>
+<hr/><h2 id="Constants">Constants</h2>
+<table class="table-bordered table-striped table-condensed"><thead><th>Constant</th><th>Type</th><th>Value</th></thead>
+<tr id="Const_DEFAULT_ID"><td><code>DEFAULT_ID</code></td><td><code>string</code></td><td><code>"DO_NOT_SET_AT_CLIENTS"</code></td></tr></table><hr/><h2 id="Enumerations">Enumerations</h2>
+<div class="definition"><h3 id="Enum_DataType">Enumeration: DataType</h3>
+Data Types supported in Airavata. The primitive data types
+<p/>
+<br/><br/><table class="table-bordered table-striped table-condensed">
+<tr><td><code>STRING</code></td><td><code>0</code></td><td>
+</td></tr>
+<tr><td><code>INTEGER</code></td><td><code>1</code></td><td>
+</td></tr>
+<tr><td><code>FLOAT</code></td><td><code>2</code></td><td>
+</td></tr>
+<tr><td><code>URI</code></td><td><code>3</code></td><td>
+</td></tr>
+</table></div>
+<hr/><h2 id="Structs">Data structures</h2>
+<div class="definition"><h3 id="Struct_InputDataObjectType">Struct: InputDataObjectType</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
+<tr><td>2</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>3</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>type</td><td><code><a href="applicationInterfaceModel.html#Enum_DataType">DataType</a></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>applicationArgument</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>standardInput</td><td><code>bool</code></td><td></td><td>optional</td><td>0</td></tr>
+<tr><td>7</td><td>userFriendlyDescription</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>8</td><td>metaData</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+</table><br/>Application Inputs. The paramters describe how inputs are passed to the application.
+<p/>
+name:
+ Name of the parameter.
+<p/>
+value:
+ Value of the parameter. A default value could be set during registration.
+<p/>
+type:
+ Data type of the parameter
+<p/>
+applicationArguement:
+ The argument flag sent to the application. Such as -p pressure.
+<p/>
+standardInput:
+ When this value is set, the parameter is sent as standard input rather than a parameter.
+ Typically this is passed using redirection operator ">".
+<p/>
+userFriendlyDescription:
+ Description to be displayed at the user interface.
+<p/>
+metaData:
+ Any metadat. This is typically ignore by Airavata and is used by gateways for application configuration.
+<p/>
+<br/></div><div class="definition"><h3 id="Struct_OutputDataObjectType">Struct: OutputDataObjectType</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
+<tr><td>2</td><td>name</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>3</td><td>value</td><td><code>string</code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>4</td><td>type</td><td><code><a href="applicationInterfaceModel.html#Enum_DataType">DataType</a></code></td><td></td><td>optional</td><td></td></tr>
+</table><br/>Application Outputs. The paramters describe how outputs generated by the application.
+<p/>
+name:
+ Name of the parameter.
+<p/>
+value:
+ Value of the parameter.
+<p/>
+type:
+ Data type of the parameter
+<p/>
+applicationArguement:
+ The argument flag sent to the application. Such as -p pressure.
+<p/>
+standardInput:
+ When this value is set, the parameter is sent as standard input rather than a parameter.
+ Typically this is passed using redirection operator ">".
+<p/>
+userFriendlyDescription:
+ Description to be displayed at the user interface.
+<p/>
+metaData:
+ Any metadat. This is typically ignore by Airavata and is used by gateways for application configuration.
+<p/>
+<br/></div><div class="definition"><h3 id="Struct_ApplicationInterfaceDescription">Struct: ApplicationInterfaceDescription</h3>
+<table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default value</th></thead>
+<tr><td>1</td><td>isEmpty</td><td><code>bool</code></td><td></td><td>required</td><td>0</td></tr>
+<tr><td>2</td><td>applicationInterfaceId</td><td><code>string</code></td><td></td><td>required</td><td>"DO_NOT_SET_AT_CLIENTS"</td></tr>
+<tr><td>3</td><td>applicationName</td><td><code>string</code></td><td></td><td>required</td><td></td></tr>
+<tr><td>4</td><td>applicationModules</td><td><code>list<<code>string</code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>5</td><td>applicationInputs</td><td><code>list<<code><a href="applicationInterfaceModel.html#Struct_InputDataObjectType">InputDataObjectType</a></code>></code></td><td></td><td>optional</td><td></td></tr>
+<tr><td>6</td><td>applicationOutputs</td><td><code>list<<code><a href="applicationInterfaceModel.html#Struct_OutputDataObjectType">OutputDataObjectType</a></code>></code></td><td></td><td>optional</td><td></td></tr>
+</table><br/>Application Interface Description
+<p/>
+<p/>
+appDeploymentId:
+ Corelated the interface to a particular application deployment
+<p/>
+<p/>
+<br/></div></div></body></html>