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