KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > beehive > netui > tags > html > IUrlParams


1 /*
2  * Copyright 2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
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  * $Header:$
17  */

18 package org.apache.beehive.netui.tags.html;
19
20 import javax.servlet.jsp.JspException JavaDoc;
21
22 /**
23  * This interfaces defines the contract allowing tags to add parameters which will
24  * be added to URLs which they generate. The Parameter and ParameterMap tags both
25  * use this method to add parameters to ancestor tags.
26  */

27 public interface IUrlParams
28 {
29     /**
30      * This method will allow a tag that produces one or more Urls to have parameters set
31      * on the tag. The name and value should be required. The facet is optional, and
32      * allows tags producing more than one URL to have parameters set on different URLs.
33      * @param name The name of the parameter to be added to the URL.
34      * @param value The value of the parameter.
35      * @param facet The name of a facet for which the parameter should be added.
36      * @throws JspException
37      */

38     public void addParameter(String JavaDoc name, Object JavaDoc value, String JavaDoc facet) throws JspException JavaDoc;
39 }
40
Popular Tags