001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 *
027 * This file is based on:
028 * org.apache.taglibs.standard.tag.common.core.ParamParrent
029 * from the Apache JSTL 1.0 implmentation.
030 *
031 * The Apache Software License, Version 1.1
032 *
033 * Copyright (c) 1999 The Apache Software Foundation.  All rights
034 * reserved.
035 *
036 * Redistribution and use in source and binary forms, with or without
037 * modification, are permitted provided that the following conditions
038 * are met:
039 *
040 * 1. Redistributions of source code must retain the above copyright
041 *    notice, this list of conditions and the following disclaimer.
042 *
043 * 2. Redistributions in binary form must reproduce the above copyright
044 *    notice, this list of conditions and the following disclaimer in
045 *    the documentation and/or other materials provided with the
046 *    distribution.
047 *
048 * 3. The end-user documentation included with the redistribution, if
049 *    any, must include the following acknowlegement:
050 *       "This product includes software developed by the
051 *        Apache Software Foundation (http://www.apache.org/)."
052 *    Alternately, this acknowlegement may appear in the software itself,
053 *    if and wherever such third-party acknowlegements normally appear.
054 *
055 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
056 *    Foundation" must not be used to endorse or promote products derived
057 *    from this software without prior written permission. For written
058 *    permission, please contact apache@apache.org.
059 *
060 * 5. Products derived from this software may not be called "Apache"
061 *    nor may "Apache" appear in their names without prior written
062 *    permission of the Apache Group.
063 *
064 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
065 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
066 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
067 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
068 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
069 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
070 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
071 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
072 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
073 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
074 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
075 * SUCH DAMAGE.
076 * ====================================================================
077 *
078 * This software consists of voluntary contributions made by many
079 * individuals on behalf of the Apache Software Foundation.  For more
080 * information on the Apache Software Foundation, please see
081 * <http://www.apache.org/>.
082 *
083 */
084
085package org.opencms.jsp;
086
087/**
088 * Interface for tag handlers implementing valid parent tags for
089 * &lt;c:param&gt;.<p>
090 *
091 * @since 6.0.0
092 */
093public interface I_CmsJspTagParamParent {
094
095    /**
096     * Add a parameter to this tag.  The intent is that the
097     * &lt;param&gt; subtag will call this to register parameters.
098     * Assumes that 'name' and 'value' are appropriately encoded and do
099     * not contain any meaningful metacharacters; in order words, escaping
100     * is the responsibility of the caller.
101     *
102     * @param name the name of the parameter
103     * @param value the value of the parameter
104     *
105     * @see CmsJspTagParam
106     */
107    void addParameter(String name, String value);
108
109}