1 /**
2 * Copyright 2005-2012 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.web.ui;
17
18 import org.kuali.rice.core.web.format.Formatter;
19
20 /**
21 * Interface to be implemented by user interface elements that hold configuration about rendering a
22 * property
23 *
24 * @author Kuali Rice Team (rice.collab@kuali.org)
25 */
26 @Deprecated
27 public interface PropertyRenderingConfigElement {
28
29 /**
30 * @return name of the property that is to be rendered
31 */
32 public String getPropertyName();
33
34 /**
35 * @param propertyName
36 * - name of the property that is to be rendered
37 */
38 public void setPropertyName(String propertyName);
39
40 /**
41 * @return name of the property that is to be rendered
42 */
43 public String getPropertyValue();
44
45 /**
46 * @param propertyValue
47 * - value of the property that is to be rendered
48 */
49 public void setPropertyValue(String propertyValue);
50
51 /**
52 * @return value of the property that is to be rendered
53 */
54 public Formatter getFormatter();
55
56 /**
57 * @param formatter
58 * - {@link Formatter} that should be use when rendering property value
59 */
60 public void setFormatter(Formatter formatter);
61
62 /**
63 * @return name of the property that should be displayed in place of property we are rendering
64 * (only applies when read-only)
65 */
66 public String getAlternateDisplayPropertyName();
67
68 /**
69 * @param alternateDisplayPropertyName
70 * - name of the property that should be displayed in place of property we are
71 * rendering (only applies when read-only)
72 */
73 public void setAlternateDisplayPropertyName(String alternateDisplayPropertyName);
74
75 /**
76 * @return name of the property that should be displayed in addition to the property we are
77 * rendering (only applies when read-only)
78 */
79 public String getAdditionalDisplayPropertyName();
80
81 /**
82 * @param additionalDisplayPropertyName
83 * - name of the property that should be displayed in addition to the property we are
84 * rendering (only applies when read-only)
85 */
86 public void setAdditionalDisplayPropertyName(String additionalDisplayPropertyName);
87
88 }