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.renderers;
17
18 import javax.servlet.jsp.JspException;
19 import javax.servlet.jsp.PageContext;
20 import javax.servlet.jsp.tagext.Tag;
21
22 /**
23 * The contract needed by renderers of all stripes to render controls
24 */
25 public interface Renderer {
26
27 /**
28 * Asks this renderer to render
29 * @param pageContext the JSP page context to render to
30 * @param parentTag the tag that is the "parent" of this rendering
31 * @param businessObject the business object being rendered
32 */
33 public abstract void render(PageContext pageContext, Tag parentTag) throws JspException;
34
35 /**
36 * If this object is held in a pool, this method is called before the object is returned to
37 * the pool, so that the object can be cleaned up for the next use.
38 */
39 public abstract void clear();
40 }