001    /*
002     * Copyright 2011 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     */
016    package org.kuali.kfs.sys.document.web;
017    
018    /**
019     * an interface that indicates the totaling is for the nested field
020     */
021    public interface NestedFieldTotaling {
022    
023        /**
024         * set the property name of the containing object if the field for totaling is a nested property 
025         * 
026         * @param containingPropertyName the given property name of the containing object
027         */
028        public void setContainingPropertyName(String containingPropertyName);
029    
030        /**
031         * determine whether the field for totaling is a nested property
032         * 
033         * @return true if the field for totaling is a nested property; otherwise, false
034         */
035        public boolean isNestedProperty();
036    }