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