Workspace/Siman-Common/src/org/splat/dal/bo/som/ProgressState.java

   1 package org.splat.dal.bo.som;
   2
   3 /**
   4  * Study, scenario or document progress state enumeration.
   5  *
   6  * @author Daniel Brunier-Coulin
   7  * @copyright OPEN CASCADE 2012
   8  */
   9
  10 public enum ProgressState {
  11         /**
  12          * Represents inWORK, inDRAFT and inCHECK states for search purpose.
  13          */
  14         inPROGRESS,
  15         /**
  16          * The first possible state in a validation cycle.
  17          */
  18         inWORK,
  19         /**
  20          * The state after promoting from inWORK state.
  21          */
  22         inDRAFT,
  23         /**
  24          * The state after validating from inDRAFT or inWORK state.
  25          */
  26         inCHECK,
  27         /**
  28          * The state after approving from inCHECK state.
  29          */
  30         APPROVED,
  31         /**
  32          * Document-specific state representing documents produced outside studies.
  33          */
  34         EXTERN,
  35         /**
  36          * Study-specific state qualifying typical reference studies.
  37          */
  38         TEMPLATE;
  39
  40         /**
  41          * Get i18n key of the enumeration value.
  42          *
  43          * @return i18n key
  44          */
  45         public String getKey() {
  46                 return "label." + name();
  47         }
  48
  49         /**
  50          * Get enumeration constant as a string.
  51          *
  52          * @return enumeration constant name
  53          */
  54         public String getValue() {
  55                 return name();
  56         }
  57 }