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     * Interface that declares extra methods needed for renderable elements that have headers
020     */
021    public interface TableJoiningWithHeader extends TableJoining {
022        /**
023         * Returns the property of the accounting line business object that can be used to find the label for the given renderable element
024         * @param renderingContext the context the header will be rendered to
025         * @return the property to lookup the label in the data dictionary
026         */
027        public abstract HeaderLabel createHeaderLabel();
028        
029        /**
030         * Will this table joining element actually end up hidden?  Then we best not create a header cell for it
031         * @return true if the table joiner will be hidden, false otherwise - in which case a header cell will be rendered
032         */
033        public abstract boolean isHidden();
034    }