/*
 * Copyright (C) 2007-2012 Argeo GmbH
 *
 * Licensed 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.argeo.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();

}