package org.argeo.api.slc.execution;

/**
 * Possible attribute of an execution flow.
 * 
 * There are mainly two implementations :<br>
 * + Primitive attributes (no predefined choice, the end user must compute a
 * String, a Float, an Integer...)<br>
 * + RefSpecAttribute which enable two things<br>
 * ++ a reference to another object of the application context<br>
 * ++ the display of some choices among which the end user can choose.<br>
 * 
 * @see org.argeo.slc.core.execution.PrimitiveSpecAttribute
 * @see org.argeo.slc.core.execution.RefSpecAttribute
 * @see org.argeo.slc.core.execution.PrimitiveUtils : this class offers some
 *      helper, among others to cast the various type of primitive attribute.
 */
public interface ExecutionSpecAttribute {
	/**
	 * Whether this attribute has to be set at instantiation of the flow and
	 * cannot be modified afterwards. If the attribute is not immutable (that
	 * is, this method returns false), it can be set at execution time.
	 */
	public Boolean getIsImmutable();

	/**
	 * Whether this attribute must be explicitly set and cannot be modified.
	 * This attribute is then basically a constant within a given application
	 * context. {@link #getValue()} cannot return null if the attribute is a
	 * constant.
	 */
	public Boolean getIsConstant();

	/** Whether this attribute will be hidden to end users. */
	public Boolean getIsHidden();

	/**
	 * The default value for this attribute. Can be null, except if
	 * {@link #getIsFrozen()} is <code>true</code>, in which case it represents
	 * the constant value of this attribute.
	 */
	public Object getValue();

	/** Description of this attribute, can be null */
	public String getDescription();

	/** @deprecated use {@link #getIsImmutable()} instead */
	public Boolean getIsParameter();

	/** @deprecated use {@link #getIsConstant()} instead */
	public Boolean getIsFrozen();

}