/*

  * Copyright 2011 The Kuali Foundation

  *

  * Licensed under the Educational Community License, Version 1.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.opensource.org/licenses/ecl1.php

  *

  * 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.kuali.rice.kns.datadictionary;

 import org.apache.commons.lang.StringUtils;

 import org.kuali.rice.kns.datadictionary.validation.capability.ExistenceConstrainable;

 /**

  * Common class for attribute definitions in the DataDictionary, which contains

  * information relating to the display, validation, and general maintenance of a

  * specific attribute of an entry. An attribute can be a simple or complex attribute.

  *  

  */

 public abstract class AttributeDefinitionBase extends DataDictionaryDefinitionBase implements ExistenceConstrainable{

         protected String name;

         protected String label;

         protected String shortLabel;

         protected String displayLabelAttribute;

         protected String messageKey;        

         protected String summary;

         //Note: This is the actual constraint text that appears below field

         protected String constraint;

         protected String description;

         protected Boolean required = Boolean.FALSE;

         public String getName() {

                 return name;

         }

         /*

          * name = name of attribute

          */

         public void setName(String name) {

                 if (StringUtils.isBlank(name)) {

                         throw new IllegalArgumentException("invalid (blank) name");

                 }

                 this.name = name;

         }

         public String getLabel() {

                 return label;

         }

         /**

          * The label element is the field or collection name that will be shown on

          * inquiry and maintenance screens. This will be overridden by presence of

          * displayLabelAttribute element.

          */

         public void setLabel(String label) {

                 if (StringUtils.isBlank(label)) {

                         throw new IllegalArgumentException("invalid (blank) label");

                 }

                 this.label = label;

         }

         /**

          * @return the shortLabel, or the label if no shortLabel has been set

          */

         public String getShortLabel() {

                 return (shortLabel != null) ? shortLabel : getLabel();

         }

         /**

          * @return the shortLabel directly, without substituting in the label

          */

         protected String getDirectShortLabel() {

                 return shortLabel;

         }

         /**

          * The shortLabel element is the field or collection name that will be used

          * in applications when a shorter name (than the label element) is required.

          * This will be overridden by presence of displayLabelAttribute element.

          */

         public void setShortLabel(String shortLabel) {

                 if (StringUtils.isBlank(shortLabel)) {

                         throw new IllegalArgumentException("invalid (blank) shortLabel");

                 }

                 this.shortLabel = shortLabel;

         }

         /**

          * The required element allows values of "true" or "false". A value of

          * "true" indicates that a value must be entered for this business object

          * when creating or editing a new business object.

          */

         public void setRequired(Boolean required) {

                 this.required = required;

         }

         @Override

         public Boolean isRequired() {

                 return this.required;

         }

         public String getSummary() {

                 return summary;

         }

         /**

          * The summary element is used to provide a short description of the

          * attribute or collection. This is designed to be used for help purposes.

          */

         public void setSummary(String summary) {

                 this.summary = summary;

         }

         public String getDescription() {

                 return description;

         }

         /**

          * The description element is used to provide a long description of the

          * attribute or collection. This is designed to be used for help purposes.

          */

         public void setDescription(String description) {

                 this.description = description;

         }

         public String getDisplayLabelAttribute() {

                 return displayLabelAttribute;

         }

         /**

          * The displayLabelAttribute element is used to indicate that the label and

          * short label should be obtained from another attribute.

          * 

          * The label element and short label element defined for this attribute will

          * be overridden. Instead, the label and short label values will be obtained

          * by referencing the corresponding values from the attribute indicated by

          * this element.

          */

         public void setDisplayLabelAttribute(String displayLabelAttribute) {

                 this.displayLabelAttribute = displayLabelAttribute;

         }

 }