Author: samindaw
Date: Wed Dec 19 16:34:04 2012
New Revision: 1423928
URL: http://svn.apache.org/viewvc?rev=1423928&view=rev
Log:
adding ExperimentAdvanceOptions interface
Added:
airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExperimentAdvanceOptions.java
(with props)
Modified:
airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataAPI.java
Modified:
airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataAPI.java
URL:
http://svn.apache.org/viewvc/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataAPI.java?rev=1423928&r1=1423927&r2=1423928&view=diff
==============================================================================
---
airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataAPI.java
(original)
+++
airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataAPI.java
Wed Dec 19 16:34:04 2012
@@ -23,8 +23,6 @@ package org.apache.airavata.client.api;
import org.apache.airavata.common.utils.Version;
-import java.util.Observable;
-
/**
* This is the base interface for AiravataAPI which contains all the base
methods for Airavata API
Added:
airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExperimentAdvanceOptions.java
URL:
http://svn.apache.org/viewvc/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExperimentAdvanceOptions.java?rev=1423928&view=auto
==============================================================================
---
airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExperimentAdvanceOptions.java
(added)
+++
airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExperimentAdvanceOptions.java
Wed Dec 19 16:34:04 2012
@@ -0,0 +1,107 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+
+package org.apache.airavata.client.api;
+
+import
org.apache.airavata.common.workflow.execution.context.WorkflowContextHeaderBuilder;
+
+public interface ExperimentAdvanceOptions {
+
+ /**
+ * Get the user who will be running the experiment if different from
the experiment
+ * submitting user
+ * @return
+ */
+ public String getExperimentExecutionUser();
+
+ /**
+ * Get the metadata for the experiment
+ * @return
+ */
+ public String getExperimentMetadata();
+
+ /**
+ * Get the name of the experiment
+ * @return
+ */
+ public String getExperimentName();
+
+ /**
+ * Get the custom Id that will be used as the experiment Id
+ * @return
+ */
+ public String getCustomExperimentId();
+
+ /**
+ * Get the custom workflow context settings
+ * @return
+ */
+ public WorkflowContextHeaderBuilder getCustomWorkflowContext();
+
+ /**
+ * Set a 3rd party user identity as the user who performed this
experiment. If not specified
+ * the experiment submission user will be used as the execution user
+ */
+ public void setExperimentExecutioUser(String experimentExecutionUser);
+
+ /**
+ * Set custom metadata for the experiment.
+ * Note: Users can store custom data related to experiment along with
the experiment and
+ * retrieve them later on
+ */
+ public void setExperimentCustomMetadata();
+
+ /**
+ * Set the name of the experiment. Must be unique. If not defined the
name will be
+ * auto-generated using the worklfow template Id & & time of experiment
submission
+ */
+ public void setExperimentName();
+
+ /**
+ * Set a custom id as an experiment Id. If not specified the system
will autogenerate an
+ * experiment id
+ */
+ public void setCustomExperimentId();
+
+ /**
+ * Set a custom workflow context to the experiment. From this users can
specify scheduling,
+ * output handling & security related custom settings. If not specified
a default empty workflow
+ * context will be used.
+ * @param builder
+ */
+ public void setCustomWorkflowContext(WorkflowContextHeaderBuilder
builder);
+
+ /**
+ * Create a new Workflow Context object.
+ * Note: This will not be set it as the Custom Workflow Context in the
ExperimentAdanceOptions.
+ * Users should use <code>setCustomWorkflowContext</code> function to
do so.
+ * @return
+ */
+ public WorkflowContextHeaderBuilder newCustomWorkflowContext();
+
+ /**
+ * Create a unique experiment Id.
+ * Note: This will not be set as the experiment Id for the experiment.
Users should use
+ * <code>setCustomExperimentId</code> function to do so.
+ * @return
+ */
+ public String generatExperimentId();
+}
Propchange:
airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExperimentAdvanceOptions.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
