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.renderers;
017    
018    import javax.servlet.jsp.JspException;
019    import javax.servlet.jsp.PageContext;
020    import javax.servlet.jsp.tagext.Tag;
021    
022    /**
023     * The contract needed by renderers of all stripes to render controls
024     */
025    public interface Renderer {
026        
027        /**
028         * Asks this renderer to render
029         * @param pageContext the JSP page context to render to
030         * @param parentTag the tag that is the "parent" of this rendering
031         * @param businessObject the business object being rendered
032         */
033        public abstract void render(PageContext pageContext, Tag parentTag) throws JspException;
034        
035        /**
036         * If this object is held in a pool, this method is called before the object is returned to
037         * the pool, so that the object can be cleaned up for the next use.
038         */
039        public abstract void clear();
040    }