KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mmbase > bridge > jsp > taglib > NodeProvider


1 /*
2
3 This software is OSI Certified Open Source Software.
4 OSI Certified is a certification mark of the Open Source Initiative.
5
6 The license (Mozilla version 1.0) can be read at the MMBase site.
7 See http://www.MMBase.org/license
8
9 */
10 package org.mmbase.bridge.jsp.taglib;
11 import javax.servlet.jsp.JspTagException JavaDoc;
12
13 import org.mmbase.bridge.jsp.taglib.containers.FunctionContainerOrNodeProvider;
14
15 import org.mmbase.bridge.*;
16
17 /**
18  * Interface designed to make it possible for child tags to access a node defined in a tag
19  *
20  * @author Michiel Meeuwissen
21  * @version $Id: NodeProvider.java,v 1.12 2006/05/17 19:14:35 michiel Exp $
22  */
23
24 public interface NodeProvider extends TagIdentifier, FunctionContainerOrNodeProvider {
25
26     /**
27      * @return the node contained in the tag
28      * NOTE: we have decided to call this method getNodeVar because
29      * we use tag attributes with name "node" and type String
30      **/
31     Node getNodeVar() throws JspTagException JavaDoc;
32
33     /**
34      * NodeProviders support the jspvar attribute (giving a Node jsp var object).
35      */
36     void setJspvar(String JavaDoc jv);
37
38
39     /**
40      * Returns a query which (a.o) results this Node.
41      * @todo EXPERIMENTAL
42      * @since MMBase-1.8
43      */
44     Query getGeneratingQuery() throws JspTagException JavaDoc;
45
46
47     /**
48      * Whether the node must be commited after the body of the tag if any changes occured
49      * @since MMBase-1.8
50      */
51     void setCommitonclose(String JavaDoc c) throws JspTagException JavaDoc;
52
53 }
54
Popular Tags