/*
 * Copyright (C) 2013 salesforce.com, inc.
 *
 * Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
 *
 * 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.auraframework.def;

public interface AttributeDesignDef extends Definition {
    /**
     * True if the attribute requires a value at design time.
     */
    public boolean isRequired();

    /**
     * True is the attribute is read only
     */
    public boolean isReadOnly();

    /**
     * Special type for design attributes
     * 
     * Optional. Will be null unless specified.
     */
    public String getType();

    /**
     * Name of the attribute this attribute has a dependency on.
     * 
     * Null if none.
     */
    public String getDependsOnAttribute();

    /**
     * Comma separated list of values or class describing the data source.
     * 
     * Optional. Will be null unless specified.
     */
    public String getDataSource();

    /**
     * Minimum value allowed for attributes.
     * 
     * Optional. Will be null unless specified.
     */
    public String getMin();

    /**
     * Maximum value allowed for attributes.
     * 
     * Optional. Will be null unless specified.
     */
    public String getMax();

    /**
     * Localized title of the attribute.
     * 
     * Null if the localization isn't found. Does not throw an exception.
     */
    public String getLabel();

    /**
     * Localized placeholder text for the attribute. This is the ghosted text in textfields and textareas before you
     * start typing into it. Doesn't apply to all attribute types.
     * 
     * Null if the localization isn't found.
     */
    public String getPlaceholderText();

}

@@ -713,15 +713,81 @@
   * 
-True if
+Get the attribute design time requiredness%0A     * %0A     * @return whether
  the
@@ -891,15 +891,83 @@
   * 
-True is
+Get the attribute design time read only flag%0A     * %0A     * @return whether
  the
@@ -989,16 +989,31 @@
 ead only
+ at design time
 %0A     */
@@ -1062,17 +1062,25 @@
 %0A     * 
-S
+Get the s
 pecial t
@@ -1087,16 +1087,21 @@
 ype for 
+this 
 design a
@@ -1108,17 +1108,17 @@
 ttribute
-s
+.
 %0A     * 
@@ -1129,48 +1129,45 @@
   * 
-Optional. Will be null unless specified.
+@return the special type, may be null
 %0A   
@@ -1216,17 +1216,25 @@
 %0A     * 
-N
+Get the n
 ame of t
@@ -1285,37 +1285,143 @@
  on.
-%0A     * %0A     * Null if none.
+ This is necessary for tracking relationships%0A     * between attributes.%0A     * %0A     * @return the name of the dependency, may be null
 %0A   
@@ -1484,17 +1484,68 @@
 %0A     * 
-C
+Get the attribute's datasource. This can include a c
 omma sep
@@ -1594,16 +1594,23 @@
 the data
+%0A     *
  source.
@@ -1629,48 +1629,55 @@
   * 
-Optional. Will be null unless specified.
+@return the attribute's datasource, may be null
 %0A   
@@ -1732,17 +1732,25 @@
 %0A     * 
-M
+Get the m
 inimum v
@@ -1797,48 +1797,46 @@
   * 
-Optional. Will be null unless specified.
+@return the minimum value, may be null
 %0A   
@@ -1884,17 +1884,25 @@
 %0A     * 
-M
+Get the m
 aximum v
@@ -1949,48 +1949,46 @@
   * 
-Optional. Will be null unless specified.
+@return the maximum value, may be null
 %0A   
@@ -2028,33 +2028,41 @@
 %0A    /**%0A     * 
-L
+Get the l
 ocalized title o
@@ -2085,39 +2085,39 @@
 %0A     * %0A     * 
-Null if
+@return
  the localizatio
@@ -2116,55 +2116,29 @@
 aliz
-ation isn't found. Does not throw an exception.
+ed title, may be null
 %0A   
@@ -2384,15 +2384,15 @@
   * 
-Null if
+@return
  the
@@ -2403,26 +2403,40 @@
 aliz
-ation isn't found.
+ed placeholder text, may be null
 %0A   

update javadoc for AttributeDesignDef