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