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

   1 package org.argeo.slc.execution;
   2
   3 /**
   4  * Possible attribute of an execution flow.
   5  *
   6  * There are mainly two implementations :<br>
   7  * + Primitive attributes (no predefined choice, the end user must compute a
   8  * String, a Float, an Integer...)<br>
   9  * + RefSpecAttribute which enable two things<br>
  10  * ++ a reference to another object of the application context<br>
  11  * ++ the display of some choices among which the end user can choose.<br>
  12  *
  13  * @see org.argeo.slc.core.execution.PrimitiveSpecAttribute
  14  * @see org.argeo.slc.core.execution.RefSpecAttribute
  15  * @see org.argeo.slc.core.execution.PrimitiveUtils : this class offers some
  16  *      helper, among others to cast the various type of primitive attribute.
  17  */
  18 public interface ExecutionSpecAttribute {
  19         /**
  20          * Whether this attribute has to be set at instantiation of the flow and
  21          * cannot be modified afterwards. If the attribute is not immutable (that
  22          * is, this method returns false), it can be set at execution time.
  23          */
  24         public Boolean getIsImmutable();
  25
  26         /**
  27          * Whether this attribute must be explicitly set and cannot be modified.
  28          * This attribute is then basically a constant within a given application
  29          * context. {@link #getValue()} cannot return null if the attribute is a
  30          * constant.
  31          */
  32         public Boolean getIsConstant();
  33
  34         /** Whether this attribute will be hidden to end users. */
  35         public Boolean getIsHidden();
  36
  37         /**
  38          * The default value for this attribute. Can be null, except if
  39          * {@link #getIsFrozen()} is <code>true</code>, in which case it represents
  40          * the constant value of this attribute.
  41          */
  42         public Object getValue();
  43
  44         /** Description of this attribute, can be null */
  45         public String getDescription();
  46
  47         /** @deprecated use {@link #getIsImmutable()} instead */
  48         public Boolean getIsParameter();
  49
  50         /** @deprecated use {@link #getIsConstant()} instead */
  51         public Boolean getIsFrozen();
  52
  53 }