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.kns.web.ui;
017
018import org.kuali.rice.core.web.format.Formatter;
019
020/**
021 * Interface to be implemented by user interface elements that hold configuration about rendering a
022 * property
023 * 
024 * @author Kuali Rice Team (rice.collab@kuali.org)
025 */
026@Deprecated
027public interface PropertyRenderingConfigElement {
028
029        /**
030         * @return name of the property that is to be rendered
031         */
032        public String getPropertyName();
033
034        /**
035         * @param propertyName
036         *            - name of the property that is to be rendered
037         */
038        public void setPropertyName(String propertyName);
039
040        /**
041         * @return name of the property that is to be rendered
042         */
043        public String getPropertyValue();
044
045        /**
046         * @param propertyValue
047         *            - value of the property that is to be rendered
048         */
049        public void setPropertyValue(String propertyValue);
050
051        /**
052         * @return value of the property that is to be rendered
053         */
054        public Formatter getFormatter();
055
056        /**
057         * @param formatter
058         *            - {@link Formatter} that should be use when rendering property value
059         */
060        public void setFormatter(Formatter formatter);
061
062        /**
063         * @return name of the property that should be displayed in place of property we are rendering
064         *         (only applies when read-only)
065         */
066        public String getAlternateDisplayPropertyName();
067
068        /**
069         * @param alternateDisplayPropertyName
070         *            - name of the property that should be displayed in place of property we are
071         *            rendering (only applies when read-only)
072         */
073        public void setAlternateDisplayPropertyName(String alternateDisplayPropertyName);
074
075        /**
076         * @return name of the property that should be displayed in addition to the property we are
077         *         rendering (only applies when read-only)
078         */
079        public String getAdditionalDisplayPropertyName();
080
081        /**
082         * @param additionalDisplayPropertyName
083         *            - name of the property that should be displayed in addition to the property we are
084         *            rendering (only applies when read-only)
085         */
086        public void setAdditionalDisplayPropertyName(String additionalDisplayPropertyName);
087
088}