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 KNS Struts deprecated, use KRAD and the Spring MVC framework.
027 */
028@Deprecated
029public interface PropertyRenderingConfigElement {
030
031        /**
032         * @return name of the property that is to be rendered
033         */
034        public String getPropertyName();
035
036        /**
037         * @param propertyName
038         *            - name of the property that is to be rendered
039         */
040        public void setPropertyName(String propertyName);
041
042        /**
043         * @return name of the property that is to be rendered
044         */
045        public String getPropertyValue();
046
047        /**
048         * @param propertyValue
049         *            - value of the property that is to be rendered
050         */
051        public void setPropertyValue(String propertyValue);
052
053        /**
054         * @return value of the property that is to be rendered
055         */
056        public Formatter getFormatter();
057
058        /**
059         * @param formatter
060         *            - {@link Formatter} that should be use when rendering property value
061         */
062        public void setFormatter(Formatter formatter);
063
064        /**
065         * @return name of the property that should be displayed in place of property we are rendering
066         *         (only applies when read-only)
067         */
068        public String getAlternateDisplayPropertyName();
069
070        /**
071         * @param alternateDisplayPropertyName
072         *            - name of the property that should be displayed in place of property we are
073         *            rendering (only applies when read-only)
074         */
075        public void setAlternateDisplayPropertyName(String alternateDisplayPropertyName);
076
077        /**
078         * @return name of the property that should be displayed in addition to the property we are
079         *         rendering (only applies when read-only)
080         */
081        public String getAdditionalDisplayPropertyName();
082
083        /**
084         * @param additionalDisplayPropertyName
085         *            - name of the property that should be displayed in addition to the property we are
086         *            rendering (only applies when read-only)
087         */
088        public void setAdditionalDisplayPropertyName(String additionalDisplayPropertyName);
089
090}