001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.datadictionary.control;
017
018import org.kuali.rice.krad.datadictionary.DataDictionaryDefinition;
019
020/**
021 * ControlDefinition
022 *
023 *
024 */
025@Deprecated
026public interface ControlDefinition extends DataDictionaryDefinition {
027
028    public boolean isDatePicker();
029    public void setDatePicker(boolean datePicker);
030    
031    public boolean isExpandedTextArea();
032    public void setExpandedTextArea(boolean eTextArea);
033
034    /**
035     * @return true if this ControlDefinition instance represents an HTML checkbox control
036     */
037    public boolean isCheckbox();
038
039    /**
040     * @return true if this ControlDefinition instance represents an HTML hidden control
041     */
042    public boolean isHidden();
043
044    /**
045     * @return true if this ControlDefinition instance represents an HTML radiobutton control
046     */
047    public boolean isRadio();
048
049    /**
050     * @return true if this ControlDefinition instance represents an HTML select control
051     */
052    public boolean isSelect();
053    
054    /**
055     * @return true if this ControlDefinition instance represents an HTML select control
056     */
057    public boolean isMultiselect();
058
059    /**
060     * @return true if this ControlDefinition instance represents an HTML text control
061     */
062    public boolean isText();
063
064    /**
065     * @return true if this ControlDefinition instance represents an HTML textarea control
066     */
067    public boolean isTextarea();
068
069    /**
070     *
071     * @return any Script associated with this control
072     */
073    public String getScript();
074
075    /**
076     * @return true if the ControlDefinition instance represents a currency control
077     */
078    public boolean isCurrency();
079
080    /**
081     *
082     * @return true if the ControlDefinition instance represents a kualiUser control
083     */
084    public boolean isKualiUser();
085
086    /**
087     * @return true if the ControlDefinition instance represents a workflow workgroup control
088     */
089    public boolean isWorkflowWorkgroup();
090
091    /**
092     * @return true if this ControlDefinition instance represents an HTML File control
093     */
094    public boolean isFile();
095    
096    /**
097     * @return true if the ControlDefinition instance represents a lookupHidden control
098     */
099    public boolean isLookupHidden();
100
101    /**
102     * @return true if the ControlDefinition instance represents a lookupReadonly control
103     */
104    public boolean isLookupReadonly();
105    
106    /**
107     * @return true if the ControlDefinition instance represents a button control
108     */
109    public boolean isButton();
110    
111    /**
112     * @return true if the ControlDefinition instance represents a link control
113     */
114    public boolean isLink();
115    
116    /**
117     * @return true if the ControlDefinition instance represents a ranged (will render from and to fields) date control
118     */   
119    public boolean isRanged();
120    
121    /**
122     * Sets the Class used to retrieve the complete range of values for radiobutton and select controls.
123     *
124     * @param valuesFinderClass
125     */
126    public void setValuesFinderClass(String valuesFinderClass);
127
128    /**
129     * Sets the BO Class used for the KeyLabelBusinessObjectValueFinder to retrieve the complete range of values for radiobutton and select controls.
130     *
131     * @param businessObjectClass
132     */
133    public void setBusinessObjectClass(String businessObjectClass);
134
135
136    /**
137     * Sets the keyAttribute used for building radiobutton and select controls.
138     *
139     * @param keyAttribute
140     */
141    public void setKeyAttribute(String keyAttribute);
142
143    /**
144     * Sets the labelAttribute used for building radiobutton and select controls.
145     *
146     * @param labelAttribute
147     */
148    public void setLabelAttribute(String labelAttribute);
149
150    public void setIncludeBlankRow(Boolean includeBlankRow);
151    
152    /**
153     * @param includeKeyInLabel whether to include the key with the label to be displayed or not.
154     */
155    public void setIncludeKeyInLabel(Boolean includeKeyInLabel);
156
157    /**
158     * Sets the Script
159     *
160     * @param script
161     */
162    public void setScript(String script);
163
164    /**
165     * @return Class used to retrieve the complete range of values for radiobutton and select controls.
166     */
167    public String getValuesFinderClass();
168
169    /**
170     * @return BO Class used for the KeyLabelBusinessObjectValueFinder to retrieve the complete range of values for radiobutton and select controls.
171     */
172    public String getBusinessObjectClass();
173
174    /**
175     * @return the keyAttribute used for radiobutton and select controls.
176     */
177    public String getKeyAttribute();
178
179    /**
180     * @return the labelAttribute used for radiobutton and select controls.
181     */
182    public String getLabelAttribute();
183
184    public Boolean getIncludeBlankRow();
185    
186    /**
187     * Gets the flag that indicates if the labels the ValuesFinder class returns should include the key.
188     *
189     * @param includeKeyInLabel
190     */
191    public Boolean getIncludeKeyInLabel();
192
193    /**
194     * Sets the size parameter for text controls.
195     *
196     * @param size
197     */
198    public void setSize(Integer size);
199
200    /**
201     * @return size parameters for text controls
202     */
203    public Integer getSize();
204
205    /**
206     * Sets the rows parameter for textarea controls.
207     *
208     * @param rows
209     */
210    public void setRows(Integer rows);
211
212    /**
213     * @return rows parameters for textarea controls
214     */
215    public Integer getRows();
216
217    /**
218     * Sets the cols parameter for textarea controls.
219     *
220     * @param cols
221     */
222    public void setCols(Integer cols);
223
224    /**
225     * @return cols parameter for textarea controls.
226     */
227    public Integer getCols();
228
229}