View Javadoc
1   /**
2    * Copyright 2005-2016 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.uif.component;
17  
18  /**
19   * Components that bind to a model (hold model data) should implement this interface.
20   *
21   * <p>Provides access to the {@link org.kuali.rice.krad.uif.component.BindingInfo} object for the component that
22   * contains binding configuration</p>
23   *
24   * @author Kuali Rice Team (rice.collab@kuali.org)
25   */
26  public interface DataBinding extends Component {
27  
28  	/**
29  	 * Returns the <code>BindingInfo</code> instance that is configured for the
30  	 * component
31  	 *
32  	 * @return BindingInfo
33  	 * @see org.kuali.rice.krad.uif.component.BindingInfo
34  	 */
35  	BindingInfo getBindingInfo();
36  
37      /**
38       * Setter for the binding info instance
39       *
40       * @param bindingInfo
41       */
42      void setBindingInfo(BindingInfo bindingInfo);
43  
44  	/**
45  	 * Name of the property (relative to the parent object) the component binds
46  	 * to
47  	 *
48  	 * @return String property name
49  	 */
50  	String getPropertyName();
51  }