View Javadoc

1   /**
2    * Copyright 2005-2012 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
20   * interface
21   *
22   * <p>
23   * Provides access to the <code>BindingInfo</code> object for the component that
24   * contains binding configuration
25   * </p>
26   *
27   * @author Kuali Rice Team (rice.collab@kuali.org)
28   */
29  public interface DataBinding {
30  
31  	/**
32  	 * Returns the <code>BindingInfo</code> instance that is configured for the
33  	 * component
34  	 *
35  	 * @return BindingInfo
36  	 * @see org.kuali.rice.krad.uif.component.BindingInfo
37  	 */
38  	public BindingInfo getBindingInfo();
39  
40      /**
41       * Setter for the binding info instance
42       *
43       * @param bindingInfo
44       */
45      public void setBindingInfo(BindingInfo bindingInfo);
46  
47  	/**
48  	 * Name of the property (relative to the parent object) the component binds
49  	 * to
50  	 *
51  	 * @return String property name
52  	 */
53  	public String getPropertyName();
54  }