View Javadoc
1   /*
2    * Copyright 2008 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.ole.sys.document.web;
17  
18  /**
19   * an interface that indicates the totaling is for the nested field
20   */
21  public interface NestedFieldTotaling {
22  
23      /**
24       * set the property name of the containing object if the field for totaling is a nested property 
25       * 
26       * @param containingPropertyName the given property name of the containing object
27       */
28      public void setContainingPropertyName(String containingPropertyName);
29  
30      /**
31       * determine whether the field for totaling is a nested property
32       * 
33       * @return true if the field for totaling is a nested property; otherwise, false
34       */
35      public boolean isNestedProperty();
36  }