Refactor Argeo API

[gpl/argeo-slc.git] / org.argeo.api.slc / src / org / argeo / api / slc / execution / ExecutionSpec.java

diff --git a/org.argeo.api.slc/src/org/argeo/api/slc/execution/ExecutionSpec.java b/org.argeo.api.slc/src/org/argeo/api/slc/execution/ExecutionSpec.java
new file mode 100644 (file)
index 0000000..079c63b
--- /dev/null
+++ b/org.argeo.api.slc/src/org/argeo/api/slc/execution/ExecutionSpec.java
@@ -0,0 +1,29 @@
+package org.argeo.api.slc.execution;
+
+import java.util.Map;
+
+/**
+ * The class implementing this interface defines the map of attributes that are
+ * necessary for the corresponding ExecutionFlow.
+ */
+public interface ExecutionSpec {
+       /**
+        * The name for an internal spec (for backward compatibility where a
+        * non-null name is expected)
+        */
+       public final static String INTERNAL_NAME = "__SLC_EXECUTION_SPEC_INTERNAL";
+
+       /**
+        * The name identifying the execution spec within its application context.
+        * Can be null. An execution spec can be referenced only if its name is not
+        * null or different from {@link #INTERNAL_NAME}
+        */
+       public String getName();
+
+       /** An optional description. Can be null. */
+       public String getDescription();
+
+       /** The attributes managed by this execution spec */
+       public Map<String, ExecutionSpecAttribute> getAttributes();
+
+}