org.argeo.slc.core/src/org/argeo/slc/core/execution/AbstractSpecAttribute.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.core.execution;
  17
  18 import java.io.Serializable;
  19
  20 import org.argeo.slc.execution.ExecutionSpecAttribute;
  21
  22 /** Canonical implementation of the execution spec attribute booleans. */
  23 public abstract class AbstractSpecAttribute implements ExecutionSpecAttribute,
  24                 Serializable {
  25         private static final long serialVersionUID = 6494963738891709440L;
  26         private Boolean isImmutable = false;
  27         private Boolean isConstant = false;
  28         private Boolean isHidden = false;
  29
  30         private String description;
  31
  32         /** Has to be set at instantiation */
  33         public Boolean getIsImmutable() {
  34                 return isImmutable;
  35         }
  36
  37         public void setIsImmutable(Boolean isImmutable) {
  38                 this.isImmutable = isImmutable;
  39         }
  40
  41         /** Cannot be overridden at runtime */
  42         public Boolean getIsConstant() {
  43                 return isConstant;
  44         }
  45
  46         public void setIsConstant(Boolean isConstant) {
  47                 this.isConstant = isConstant;
  48         }
  49
  50         /** Should not be shown to the end user */
  51         public Boolean getIsHidden() {
  52                 return isHidden;
  53         }
  54
  55         public void setIsHidden(Boolean isHidden) {
  56                 this.isHidden = isHidden;
  57         }
  58
  59         /*
  60          * DEPRECATED
  61          */
  62         /** @deprecated use {@link #getIsImmutable()} instead */
  63         public Boolean getIsParameter() {
  64                 return isImmutable;
  65         }
  66
  67         /** @deprecated use {@link #getIsConstant()} instead */
  68         public Boolean getIsFrozen() {
  69                 return isConstant;
  70         }
  71
  72         /** @deprecated use {@link #setIsImmutable(Boolean)} instead */
  73         public void setIsParameter(Boolean isParameter) {
  74                 this.isImmutable = isParameter;
  75         }
  76
  77         /** @deprecated use {@link #setIsConstant(Boolean)} instead */
  78         public void setIsFrozen(Boolean isFrozen) {
  79                 this.isConstant = isFrozen;
  80         }
  81
  82         public void setDescription(String description) {
  83                 this.description = description;
  84         }
  85
  86         public String getDescription() {
  87                 return description;
  88         }
  89
  90 }