001    /**
002     * Copyright 2005-2014 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     */
016    package org.kuali.rice.krad.uif.component;
017    
018    /**
019     * Components that bind to a model (hold model data) should implement this
020     * interface
021     *
022     * <p>
023     * Provides access to the <code>BindingInfo</code> object for the component that
024     * contains binding configuration
025     * </p>
026     *
027     * @author Kuali Rice Team (rice.collab@kuali.org)
028     */
029    public interface DataBinding {
030    
031            /**
032             * Returns the <code>BindingInfo</code> instance that is configured for the
033             * component
034             *
035             * @return BindingInfo
036             * @see org.kuali.rice.krad.uif.component.BindingInfo
037             */
038            public BindingInfo getBindingInfo();
039    
040        /**
041         * Setter for the binding info instance
042         *
043         * @param bindingInfo
044         */
045        public void setBindingInfo(BindingInfo bindingInfo);
046    
047            /**
048             * Name of the property (relative to the parent object) the component binds
049             * to
050             *
051             * @return String property name
052             */
053            public String getPropertyName();
054    }