org.argeo.slc.api/src/org/argeo/slc/execution/ExecutionSpec.java

   1 /*
   2  * Copyright (C) 2007-2012 Argeo GmbH
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.argeo.slc.execution;
  17
  18 import java.util.Map;
  19
  20 /**
  21  * The class implementing this interface defines the map of attributes that are
  22  * necessary for the corresponding ExecutionFlow.
  23  */
  24 public interface ExecutionSpec {
  25         /**
  26          * The name for an internal spec (for backward compatibility where a
  27          * non-null name is expected)
  28          */
  29         public final static String INTERNAL_NAME = "__SLC_EXECUTION_SPEC_INTERNAL";
  30
  31         /**
  32          * The name identifying the execution spec within its application context.
  33          * Can be null. An execution spec can be referenced only if its name is not
  34          * null or different from {@link #INTERNAL_NAME}
  35          */
  36         public String getName();
  37
  38         /** An optional description. Can be null. */
  39         public String getDescription();
  40
  41         /** The attributes managed by this execution spec */
  42         public Map<String, ExecutionSpecAttribute> getAttributes();
  43
  44 }