Coverage Report

Coverage Report - org.kuali.rice.kns.datadictionary.control.ControlDefinition

Classes in this File

 /*
  * Copyright 2005-2007 The Kuali Foundation
  *
  * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.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.control;
 
 import org.kuali.rice.kns.datadictionary.DataDictionaryDefinition;
 
 /**
  * ControlDefinition
  *
  *
  */
 public interface ControlDefinition extends DataDictionaryDefinition {
 
     public boolean isDatePicker();
     public void setDatePicker(boolean datePicker);
     
     public boolean isExpandedTextArea();
     public void setExpandedTextArea(boolean eTextArea);
 
     /**
      * @return true if this ControlDefinition instance represents an HTML checkbox control
      */
     public boolean isCheckbox();
 
     /**
      * @return true if this ControlDefinition instance represents an HTML hidden control
      */
     public boolean isHidden();
 
     /**
      * @return true if this ControlDefinition instance represents an HTML radiobutton control
      */
     public boolean isRadio();
 
     /**
      * @return true if this ControlDefinition instance represents an HTML select control
      */
     public boolean isSelect();
     
     /**
      * @return true if this ControlDefinition instance represents an HTML select control
      */
     public boolean isMultiselect();
 
     /**
      * @return true if this ControlDefinition instance represents an HTML select control that is tied to an APC rule
      */
     public boolean isApcSelect();
 
     /**
      * @return true if this ControlDefinition instance represents an HTML text control
      */
     public boolean isText();
 
     /**
      * @return true if this ControlDefinition instance represents an HTML textarea control
      */
     public boolean isTextarea();
 
     /**
      *
      * @return any Script associated with this control
      */
     public String getScript();
 
     /**
      * @return true if the ControlDefinition instance represents a currency control
      */
     public boolean isCurrency();
 
     /**
      *
      * @return true if the ControlDefinition instance represents a kualiUser control
      */
     public boolean isKualiUser();
 
     /**
      * @return true if the ControlDefinition instance represents a workflow workgroup control
      */
     public boolean isWorkflowWorkgroup();
 
     /**
      * @return true if this ControlDefinition instance represents an HTML File control
      */
     public boolean isFile();
     
     /**
      * @return true if the ControlDefinition instance represents a lookupHidden control
      */
     public boolean isLookupHidden();
 
     /**
      * @return true if the ControlDefinition instance represents a lookupReadonly control
      */
     public boolean isLookupReadonly();
     
     /**
      * @return true if the ControlDefinition instance represents a button control
      */
     public boolean isButton();
     
     /**
      * @return true if the ControlDefinition instance represents a link control
      */
     public boolean isLink();
     
     /**
      * @return true if the ControlDefinition instance represents a ranged (will render from and to fields) date control
      */   
     public boolean isRanged();
     
     /**
      * Sets the Class used to retrieve the complete range of values for radiobutton and select controls.
      *
      * @param valuesFinderClass
      */
     public void setValuesFinderClass(String valuesFinderClass);
 
     /**
      * Sets the BO Class used for the KeyLabelBusinessObjectValueFinder to retrieve the complete range of values for radiobutton and select controls.
      *
      * @param businessObjectClass
      */
     public void setBusinessObjectClass(String businessObjectClass);
 
 
     /**
      * Sets the keyAttribute used for building radiobutton and select controls.
      *
      * @param keyAttribute
      */
     public void setKeyAttribute(String keyAttribute);
 
     /**
      * Sets the labelAttribute used for building radiobutton and select controls.
      *
      * @param labelAttribute
      */
     public void setLabelAttribute(String labelAttribute);
 
     public void setIncludeBlankRow(Boolean includeBlankRow);
     
     /**
      * @param includeKeyInLabel whether to include the key with the label to be displayed or not.
      */
     public void setIncludeKeyInLabel(Boolean includeKeyInLabel);
 
     /**
      * Sets the Script
      *
      * @param script
      */
     public void setScript(String script);
 
     /**
      * @return Class used to retrieve the complete range of values for radiobutton and select controls.
      */
     public String getValuesFinderClass();
 
     /**
      * @return BO Class used for the KeyLabelBusinessObjectValueFinder to retrieve the complete range of values for radiobutton and select controls.
      */
     public String getBusinessObjectClass();
 
     /**
      * @return the keyAttribute used for radiobutton and select controls.
      */
     public String getKeyAttribute();
 
     /**
      * @return the labelAttribute used for radiobutton and select controls.
      */
     public String getLabelAttribute();
 
     public Boolean getIncludeBlankRow();
     
     /**
      * Gets the flag that indicates if the labels the ValuesFinder class returns should include the key.
      *
      * @param includeKeyInLabel
      */
     public Boolean getIncludeKeyInLabel();
 
     /**
      * Sets the size parameter for text controls.
      *
      * @param size
      */
     public void setSize(Integer size);
 
     /**
      * @return size parameters for text controls
      */
     public Integer getSize();
 
     /**
      * Sets the rows parameter for textarea controls.
      *
      * @param rows
      */
     public void setRows(Integer rows);
 
     /**
      * @return rows parameters for textarea controls
      */
     public Integer getRows();
 
     /**
      * Sets the cols parameter for textarea controls.
      *
      * @param cols
      */
     public void setCols(Integer cols);
 
     /**
      * @return cols parameter for textarea controls.
      */
     public Integer getCols();
 
 }

1		/*
2		* Copyright 2005-2007 The Kuali Foundation
3		*
4		* Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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.kuali.rice.kns.datadictionary.control;
17
18		import org.kuali.rice.kns.datadictionary.DataDictionaryDefinition;
19
20		/**
21		* ControlDefinition
22		*
23		*
24		*/
25		public interface ControlDefinition extends DataDictionaryDefinition {
26
27		public boolean isDatePicker();
28		public void setDatePicker(boolean datePicker);
29
30		public boolean isExpandedTextArea();
31		public void setExpandedTextArea(boolean eTextArea);
32
33		/**
34		* @return true if this ControlDefinition instance represents an HTML checkbox control
35		*/
36		public boolean isCheckbox();
37
38		/**
39		* @return true if this ControlDefinition instance represents an HTML hidden control
40		*/
41		public boolean isHidden();
42
43		/**
44		* @return true if this ControlDefinition instance represents an HTML radiobutton control
45		*/
46		public boolean isRadio();
47
48		/**
49		* @return true if this ControlDefinition instance represents an HTML select control
50		*/
51		public boolean isSelect();
52
53		/**
54		* @return true if this ControlDefinition instance represents an HTML select control
55		*/
56		public boolean isMultiselect();
57
58		/**
59		* @return true if this ControlDefinition instance represents an HTML select control that is tied to an APC rule
60		*/
61		public boolean isApcSelect();
62
63		/**
64		* @return true if this ControlDefinition instance represents an HTML text control
65		*/
66		public boolean isText();
67
68		/**
69		* @return true if this ControlDefinition instance represents an HTML textarea control
70		*/
71		public boolean isTextarea();
72
73		/**
74		*
75		* @return any Script associated with this control
76		*/
77		public String getScript();
78
79		/**
80		* @return true if the ControlDefinition instance represents a currency control
81		*/
82		public boolean isCurrency();
83
84		/**
85		*
86		* @return true if the ControlDefinition instance represents a kualiUser control
87		*/
88		public boolean isKualiUser();
89
90		/**
91		* @return true if the ControlDefinition instance represents a workflow workgroup control
92		*/
93		public boolean isWorkflowWorkgroup();
94
95		/**
96		* @return true if this ControlDefinition instance represents an HTML File control
97		*/
98		public boolean isFile();
99
100		/**
101		* @return true if the ControlDefinition instance represents a lookupHidden control
102		*/
103		public boolean isLookupHidden();
104
105		/**
106		* @return true if the ControlDefinition instance represents a lookupReadonly control
107		*/
108		public boolean isLookupReadonly();
109
110		/**
111		* @return true if the ControlDefinition instance represents a button control
112		*/
113		public boolean isButton();
114
115		/**
116		* @return true if the ControlDefinition instance represents a link control
117		*/
118		public boolean isLink();
119
120		/**
121		* @return true if the ControlDefinition instance represents a ranged (will render from and to fields) date control
122		*/
123		public boolean isRanged();
124
125		/**
126		* Sets the Class used to retrieve the complete range of values for radiobutton and select controls.
127		*
128		* @param valuesFinderClass
129		*/
130		public void setValuesFinderClass(String valuesFinderClass);
131
132		/**
133		* Sets the BO Class used for the KeyLabelBusinessObjectValueFinder to retrieve the complete range of values for radiobutton and select controls.
134		*
135		* @param businessObjectClass
136		*/
137		public void setBusinessObjectClass(String businessObjectClass);
138
139
140		/**
141		* Sets the keyAttribute used for building radiobutton and select controls.
142		*
143		* @param keyAttribute
144		*/
145		public void setKeyAttribute(String keyAttribute);
146
147		/**
148		* Sets the labelAttribute used for building radiobutton and select controls.
149		*
150		* @param labelAttribute
151		*/
152		public void setLabelAttribute(String labelAttribute);
153
154		public void setIncludeBlankRow(Boolean includeBlankRow);
155
156		/**
157		* @param includeKeyInLabel whether to include the key with the label to be displayed or not.
158		*/
159		public void setIncludeKeyInLabel(Boolean includeKeyInLabel);
160
161		/**
162		* Sets the Script
163		*
164		* @param script
165		*/
166		public void setScript(String script);
167
168		/**
169		* @return Class used to retrieve the complete range of values for radiobutton and select controls.
170		*/
171		public String getValuesFinderClass();
172
173		/**
174		* @return BO Class used for the KeyLabelBusinessObjectValueFinder to retrieve the complete range of values for radiobutton and select controls.
175		*/
176		public String getBusinessObjectClass();
177
178		/**
179		* @return the keyAttribute used for radiobutton and select controls.
180		*/
181		public String getKeyAttribute();
182
183		/**
184		* @return the labelAttribute used for radiobutton and select controls.
185		*/
186		public String getLabelAttribute();
187
188		public Boolean getIncludeBlankRow();
189
190		/**
191		* Gets the flag that indicates if the labels the ValuesFinder class returns should include the key.
192		*
193		* @param includeKeyInLabel
194		*/
195		public Boolean getIncludeKeyInLabel();
196
197		/**
198		* Sets the size parameter for text controls.
199		*
200		* @param size
201		*/
202		public void setSize(Integer size);
203
204		/**
205		* @return size parameters for text controls
206		*/
207		public Integer getSize();
208
209		/**
210		* Sets the rows parameter for textarea controls.
211		*
212		* @param rows
213		*/
214		public void setRows(Integer rows);
215
216		/**
217		* @return rows parameters for textarea controls
218		*/
219		public Integer getRows();
220
221		/**
222		* Sets the cols parameter for textarea controls.
223		*
224		* @param cols
225		*/
226		public void setCols(Integer cols);
227
228		/**
229		* @return cols parameter for textarea controls.
230		*/
231		public Integer getCols();
232
233		}