1 /**
2 * Copyright 2005-2015 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 KNS Struts deprecated, use KRAD and the Spring MVC framework.
27 */
28 @Deprecated
29 public interface PropertyRenderingConfigElement {
30
31 /**
32 * @return name of the property that is to be rendered
33 */
34 public String getPropertyName();
35
36 /**
37 * @param propertyName
38 * - name of the property that is to be rendered
39 */
40 public void setPropertyName(String propertyName);
41
42 /**
43 * @return name of the property that is to be rendered
44 */
45 public String getPropertyValue();
46
47 /**
48 * @param propertyValue
49 * - value of the property that is to be rendered
50 */
51 public void setPropertyValue(String propertyValue);
52
53 /**
54 * @return value of the property that is to be rendered
55 */
56 public Formatter getFormatter();
57
58 /**
59 * @param formatter
60 * - {@link Formatter} that should be use when rendering property value
61 */
62 public void setFormatter(Formatter formatter);
63
64 /**
65 * @return name of the property that should be displayed in place of property we are rendering
66 * (only applies when read-only)
67 */
68 public String getAlternateDisplayPropertyName();
69
70 /**
71 * @param alternateDisplayPropertyName
72 * - name of the property that should be displayed in place of property we are
73 * rendering (only applies when read-only)
74 */
75 public void setAlternateDisplayPropertyName(String alternateDisplayPropertyName);
76
77 /**
78 * @return name of the property that should be displayed in addition to the property we are
79 * rendering (only applies when read-only)
80 */
81 public String getAdditionalDisplayPropertyName();
82
83 /**
84 * @param additionalDisplayPropertyName
85 * - name of the property that should be displayed in addition to the property we are
86 * rendering (only applies when read-only)
87 */
88 public void setAdditionalDisplayPropertyName(String additionalDisplayPropertyName);
89
90 }