Coverage Report

Coverage Report - org.kuali.rice.kns.web.ui.PropertyRenderingConfigElement

Classes in this File

 /*
  * Copyright 2007-2010 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.web.ui;
 
 import org.kuali.rice.core.web.format.Formatter;
 
 /**
  * Interface to be implemented by user interface elements that hold configuration about rendering a
  * property
  * 
  * @author Kuali Rice Team (rice.collab@kuali.org)
  */
 public interface PropertyRenderingConfigElement {
 
         /**
          * @return name of the property that is to be rendered
          */
         public String getPropertyName();
 
         /**
          * @param propertyName
          *            - name of the property that is to be rendered
          */
         public void setPropertyName(String propertyName);
 
         /**
          * @return name of the property that is to be rendered
          */
         public String getPropertyValue();
 
         /**
          * @param propertyValue
          *            - value of the property that is to be rendered
          */
         public void setPropertyValue(String propertyValue);
 
         /**
          * @return value of the property that is to be rendered
          */
         public Formatter getFormatter();
 
         /**
          * @param formatter
          *            - {@link Formatter} that should be use when rendering property value
          */
         public void setFormatter(Formatter formatter);
 
         /**
          * @return name of the property that should be displayed in place of property we are rendering
          *         (only applies when read-only)
          */
         public String getAlternateDisplayPropertyName();
 
         /**
          * @param alternateDisplayPropertyName
          *            - name of the property that should be displayed in place of property we are
          *            rendering (only applies when read-only)
          */
         public void setAlternateDisplayPropertyName(String alternateDisplayPropertyName);
 
         /**
          * @return name of the property that should be displayed in addition to the property we are
          *         rendering (only applies when read-only)
          */
         public String getAdditionalDisplayPropertyName();
 
         /**
          * @param additionalDisplayPropertyName
          *            - name of the property that should be displayed in addition to the property we are
          *            rendering (only applies when read-only)
          */
         public void setAdditionalDisplayPropertyName(String additionalDisplayPropertyName);
 
 }

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